Class ConfigurationClient

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

Inheritance

System.Object

ConfigurationClient

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.Data.AppConfiguration.dll

Syntax

public class ConfigurationClient

Constructors

ConfigurationClient()

Protected constructor to allow mocking.

Declaration

protected ConfigurationClient ();

ConfigurationClient(String)

Initializes a new instance of the ConfigurationClient class.

Declaration

public ConfigurationClient (string connectionString);

Parameters

System.String connectionString Connection string with authentication option and related parameters.

ConfigurationClient(String, ConfigurationClientOptions)

Initializes a new instance of the ConfigurationClient class.

Declaration

public ConfigurationClient (string connectionString, Azure.Data.AppConfiguration.ConfigurationClientOptions options);

Parameters

System.String connectionString Connection string with authentication option and related parameters.

ConfigurationClientOptions options Options that allow configuration of requests sent to the configuration store.

ConfigurationClient(Uri, TokenCredential)

Initializes a new instance of the ConfigurationClient class.

Declaration

public ConfigurationClient (Uri endpoint, Azure.Core.TokenCredential credential);

Parameters

System.Uri endpoint The System.Uri referencing the app configuration storage.

Azure.Core.TokenCredential credential The token credential used to sign requests.

ConfigurationClient(Uri, TokenCredential, ConfigurationClientOptions)

Initializes a new instance of the ConfigurationClient class.

Declaration

public ConfigurationClient (Uri endpoint, Azure.Core.TokenCredential credential, Azure.Data.AppConfiguration.ConfigurationClientOptions options);

Parameters

System.Uri endpoint The System.Uri referencing the app configuration storage.

Azure.Core.TokenCredential credential The token credential used to sign requests.

ConfigurationClientOptions options Options that allow configuration of requests sent to the configuration store.

Methods

AddConfigurationSetting(ConfigurationSetting, CancellationToken)

Creates a ConfigurationSetting only if the setting does not already exist in the configuration store.

Declaration

public virtual Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting> AddConfigurationSetting (Azure.Data.AppConfiguration.ConfigurationSetting setting, System.Threading.CancellationToken cancellationToken = null);

Parameters

ConfigurationSetting setting The ConfigurationSetting to create.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

Azure.Response<ConfigurationSetting> A response containing the added ConfigurationSetting.

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.

Declaration

public virtual Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting> AddConfigurationSetting (string key, string value, string label = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String key The primary identifier of the configuration setting.

System.String value The configuration setting's value.

System.String label A label used to group this configuration setting with others.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

Azure.Response<ConfigurationSetting> A response containing the added ConfigurationSetting.

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.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting>> AddConfigurationSettingAsync (string key, string value, string label = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String key The primary identifier of the configuration setting.

System.String value The configuration setting's value.

System.String label A label used to group this configuration setting with others.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

System.Threading.Tasks.Task<Azure.Response<ConfigurationSetting>> A response containing the added ConfigurationSetting.

AddConfigurationSettingAsync(ConfigurationSetting, CancellationToken)

Creates a ConfigurationSetting only if the setting does not already exist in the configuration store.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting>> AddConfigurationSettingAsync (Azure.Data.AppConfiguration.ConfigurationSetting setting, System.Threading.CancellationToken cancellationToken = null);

Parameters

ConfigurationSetting setting The ConfigurationSetting to create.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

System.Threading.Tasks.Task<Azure.Response<ConfigurationSetting>> A response containing the added ConfigurationSetting.

DeleteConfigurationSetting(ConfigurationSetting, Boolean, CancellationToken)

Delete a ConfigurationSetting from the configuration store.

Declaration

public virtual Azure.Response DeleteConfigurationSetting (Azure.Data.AppConfiguration.ConfigurationSetting setting, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = null);

Parameters

ConfigurationSetting setting The ConfigurationSetting to delete.

System.Boolean onlyIfUnchanged If set to true and the configuration setting exists in the configuration store, delete the setting if the passed-in ConfigurationSetting is the same version as the one in the configuration store. The setting versions are the same if their ETag fields match. If the two settings are different versions, this method will throw an exception to indicate that the setting in the configuration store was modified since it was last obtained by the client.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

Azure.Response A response indicating the success of the operation.

DeleteConfigurationSetting(String, String, CancellationToken)

Delete a ConfigurationSetting from the configuration store.

Declaration

public virtual Azure.Response DeleteConfigurationSetting (string key, string label = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String key The primary identifier of the configuration setting.

System.String label A label used to group this configuration setting with others.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

Azure.Response A response indicating the success of the operation.

DeleteConfigurationSettingAsync(ConfigurationSetting, Boolean, CancellationToken)

Delete a ConfigurationSetting from the configuration store.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteConfigurationSettingAsync (Azure.Data.AppConfiguration.ConfigurationSetting setting, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = null);

Parameters

ConfigurationSetting setting The ConfigurationSetting to delete.

System.Boolean onlyIfUnchanged If set to true and the configuration setting exists in the configuration store, delete the setting if the passed-in ConfigurationSetting is the same version as the one in the configuration store. The setting versions are the same if their ETag fields match. If the two settings are different versions, this method will throw an exception to indicate that the setting in the configuration store was modified since it was last obtained by the client.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

System.Threading.Tasks.Task<Azure.Response> A response indicating the success of the operation.

DeleteConfigurationSettingAsync(String, String, CancellationToken)

Delete a ConfigurationSetting from the configuration store.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteConfigurationSettingAsync (string key, string label = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String key The primary identifier of the configuration setting.

System.String label A label used to group this configuration setting with others.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

System.Threading.Tasks.Task<Azure.Response> A response indicating the success of the operation.

Equals(Object)

Check if two ConfigurationSetting instances are equal.

Declaration

[System.ComponentModel.EditorBrowsable]
public override bool Equals (object obj);

Parameters

System.Object obj The instance to compare to.

Returns

System.Boolean

GetConfigurationSetting(String, String, CancellationToken)

Retrieve an existing ConfigurationSetting, uniquely identified by key and label, from the configuration store.

Declaration

public virtual Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting> GetConfigurationSetting (string key, string label = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String key The primary identifier of the configuration setting to retrieve.

System.String label A label used to group this configuration setting with others.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

Azure.Response<ConfigurationSetting> A response containing the retrieved ConfigurationSetting.

GetConfigurationSetting(ConfigurationSetting, Boolean, CancellationToken)

Retrieve an existing ConfigurationSetting from the configuration store.

Declaration

public virtual Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting> GetConfigurationSetting (Azure.Data.AppConfiguration.ConfigurationSetting setting, bool onlyIfChanged = false, System.Threading.CancellationToken cancellationToken = null);

Parameters

ConfigurationSetting setting The ConfigurationSetting to retrieve.

System.Boolean onlyIfChanged If set to true, only retrieve the setting from the configuration store if it has changed since the client last retrieved it. It is determined to have changed if the ETag field on the passed-in ConfigurationSetting is different from the ETag of the setting in the configuration store. If it has not changed, the returned response will have have no value, and will throw if response.Value is accessed. Callers may check the status code on the response to avoid triggering the exception.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

Azure.Response<ConfigurationSetting> A response containing the retrieved ConfigurationSetting.

GetConfigurationSetting(ConfigurationSetting, DateTimeOffset, CancellationToken)

Retrieve an existing ConfigurationSetting from the configuration store.

Declaration

public virtual Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting> GetConfigurationSetting (Azure.Data.AppConfiguration.ConfigurationSetting setting, DateTimeOffset acceptDateTime, System.Threading.CancellationToken cancellationToken = null);

Parameters

ConfigurationSetting setting The ConfigurationSetting to retrieve.

System.DateTimeOffset acceptDateTime The setting will be retrieved exactly as it existed at the provided time.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

Azure.Response<ConfigurationSetting> A response containing the retrieved ConfigurationSetting.

GetConfigurationSettingAsync(ConfigurationSetting, DateTimeOffset, CancellationToken)

Retrieve an existing ConfigurationSetting from the configuration store.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting>> GetConfigurationSettingAsync (Azure.Data.AppConfiguration.ConfigurationSetting setting, DateTimeOffset acceptDateTime, System.Threading.CancellationToken cancellationToken = null);

Parameters

ConfigurationSetting setting The ConfigurationSetting to retrieve.

System.DateTimeOffset acceptDateTime The setting will be retrieved exactly as it existed at the provided time.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

System.Threading.Tasks.Task<Azure.Response<ConfigurationSetting>> A response containing the retrieved ConfigurationSetting.

GetConfigurationSettingAsync(String, String, CancellationToken)

Retrieve an existing ConfigurationSetting, uniquely identified by key and label, from the configuration store.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting>> GetConfigurationSettingAsync (string key, string label = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String key The primary identifier of the configuration setting to retrieve.

System.String label A label used to group this configuration setting with others.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

System.Threading.Tasks.Task<Azure.Response<ConfigurationSetting>> A response containing the retrieved ConfigurationSetting.

GetConfigurationSettingAsync(ConfigurationSetting, Boolean, CancellationToken)

Retrieve an existing ConfigurationSetting from the configuration store.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting>> GetConfigurationSettingAsync (Azure.Data.AppConfiguration.ConfigurationSetting setting, bool onlyIfChanged = false, System.Threading.CancellationToken cancellationToken = null);

Parameters

ConfigurationSetting setting The ConfigurationSetting to retrieve.

System.Boolean onlyIfChanged If set to true, only retrieve the setting from the configuration store if it has changed since the client last retrieved it. It is determined to have changed if the ETag field on the passed-in ConfigurationSetting is different from the ETag of the setting in the configuration store. If it has not changed, the returned response will have have no value, and will throw if response.Value is accessed. Callers may check the status code on the response to avoid triggering the exception.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

System.Threading.Tasks.Task<Azure.Response<ConfigurationSetting>> A response containing the retrieved ConfigurationSetting.

GetConfigurationSettings(SettingSelector, CancellationToken)

Retrieves one or more ConfigurationSetting entities that match the options specified in the passed-in SettingSelector.

Declaration

public virtual Azure.Pageable<Azure.Data.AppConfiguration.ConfigurationSetting> GetConfigurationSettings (Azure.Data.AppConfiguration.SettingSelector selector, System.Threading.CancellationToken cancellationToken = null);

Parameters

SettingSelector selector Set of options for selecting ConfigurationSetting from the configuration store.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

Azure.Pageable<ConfigurationSetting>

GetConfigurationSettingsAsync(SettingSelector, CancellationToken)

Retrieves one or more ConfigurationSetting entities that match the options specified in the passed-in SettingSelector.

Declaration

public virtual Azure.AsyncPageable<Azure.Data.AppConfiguration.ConfigurationSetting> GetConfigurationSettingsAsync (Azure.Data.AppConfiguration.SettingSelector selector, System.Threading.CancellationToken cancellationToken = null);

Parameters

SettingSelector selector Options used to select a set of ConfigurationSetting entities from the configuration store.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

Azure.AsyncPageable<ConfigurationSetting> An enumerable collection containing the retrieved ConfigurationSetting entities.

GetHashCode()

Get a hash code for the ConfigurationSetting.

Declaration

[System.ComponentModel.EditorBrowsable]
public override int GetHashCode ();

Returns

System.Int32

GetRevisions(SettingSelector, CancellationToken)

Retrieves the revisions of one or more ConfigurationSetting entities that satisfy the options of the SettingSelector.

Declaration

public virtual Azure.Pageable<Azure.Data.AppConfiguration.ConfigurationSetting> GetRevisions (Azure.Data.AppConfiguration.SettingSelector selector, System.Threading.CancellationToken cancellationToken = null);

Parameters

SettingSelector selector Set of options for selecting ConfigurationSetting from the configuration store.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

Azure.Pageable<ConfigurationSetting>

GetRevisions(String, String, CancellationToken)

Retrieves the revisions of one or more ConfigurationSetting entities that match the specified keyFilter and labelFilter.

Declaration

public virtual Azure.Pageable<Azure.Data.AppConfiguration.ConfigurationSetting> GetRevisions (string keyFilter, string labelFilter = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String keyFilter Key filter that will be used to select a set of ConfigurationSetting entities.

System.String labelFilter Label filter that will be used to select a set of ConfigurationSetting entities.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

Azure.Pageable<ConfigurationSetting>

GetRevisionsAsync(SettingSelector, CancellationToken)

Retrieves the revisions of one or more ConfigurationSetting entities that satisfy the options of the SettingSelector.

Declaration

public virtual Azure.AsyncPageable<Azure.Data.AppConfiguration.ConfigurationSetting> GetRevisionsAsync (Azure.Data.AppConfiguration.SettingSelector selector, System.Threading.CancellationToken cancellationToken = null);

Parameters

SettingSelector selector Set of options for selecting ConfigurationSetting from the configuration store.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

Azure.AsyncPageable<ConfigurationSetting>

GetRevisionsAsync(String, String, CancellationToken)

Retrieves the revisions of one or more ConfigurationSetting entities that match the specified keyFilter and labelFilter.

Declaration

public virtual Azure.AsyncPageable<Azure.Data.AppConfiguration.ConfigurationSetting> GetRevisionsAsync (string keyFilter, string labelFilter = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String keyFilter Key filter that will be used to select a set of ConfigurationSetting entities.

System.String labelFilter Label filter that will be used to select a set of ConfigurationSetting entities.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

Azure.AsyncPageable<ConfigurationSetting>

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.

Declaration

public virtual Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting> SetConfigurationSetting (string key, string value, string label = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String key The primary identifier of the configuration setting.

System.String value The configuration setting's value.

System.String label A label used to group this configuration setting with others.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

Azure.Response<ConfigurationSetting> A response containing the ConfigurationSetting written to the configuration store.

SetConfigurationSetting(ConfigurationSetting, Boolean, CancellationToken)

Creates a ConfigurationSetting if it doesn't exist or overwrites the existing setting in the configuration store.

Declaration

public virtual Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting> SetConfigurationSetting (Azure.Data.AppConfiguration.ConfigurationSetting setting, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = null);

Parameters

ConfigurationSetting setting The ConfigurationSetting to create.

System.Boolean onlyIfUnchanged If set to true and the configuration setting exists in the configuration store, overwrite the setting if the passed-in ConfigurationSetting is the same version as the one in the configuration store. The setting versions are the same if their ETag fields match. If the two settings are different versions, this method will throw an exception to indicate that the setting in the configuration store was modified since it was last obtained by the client.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

Azure.Response<ConfigurationSetting> A response containing the ConfigurationSetting written to the configuration store.

SetConfigurationSettingAsync(ConfigurationSetting, Boolean, CancellationToken)

Creates a ConfigurationSetting if it doesn't exist or overwrites the existing setting in the configuration store.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting>> SetConfigurationSettingAsync (Azure.Data.AppConfiguration.ConfigurationSetting setting, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = null);

Parameters

ConfigurationSetting setting The ConfigurationSetting to create.

System.Boolean onlyIfUnchanged If set to true and the configuration setting exists in the configuration store, overwrite the setting if the passed-in ConfigurationSetting is the same version as the one in the configuration store. The setting versions are the same if their ETag fields match. If the two settings are different versions, this method will throw an exception to indicate that the setting in the configuration store was modified since it was last obtained by the client.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

System.Threading.Tasks.Task<Azure.Response<ConfigurationSetting>> A response containing the ConfigurationSetting written to 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.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting>> SetConfigurationSettingAsync (string key, string value, string label = null, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String key The primary identifier of the configuration setting.

System.String value The configuration setting's value.

System.String label A label used to group this configuration setting with others.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

System.Threading.Tasks.Task<Azure.Response<ConfigurationSetting>> A response containing the ConfigurationSetting written to the configuration store.

SetReadOnly(String, Boolean, CancellationToken)

Sets an existing ConfigurationSetting to read only or read write state in the configuration store.

Declaration

public virtual Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting> SetReadOnly (string key, bool isReadOnly, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String key The primary identifier of the configuration setting.

System.Boolean isReadOnly If true, the ConfigurationSetting will be set to read only in the configuration store. If false, it will be set to read write.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

Azure.Response<ConfigurationSetting>

SetReadOnly(ConfigurationSetting, Boolean, Boolean, CancellationToken)

Sets an existing ConfigurationSetting to read only or read write state in the configuration store.

Declaration

public virtual Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting> SetReadOnly (Azure.Data.AppConfiguration.ConfigurationSetting setting, bool isReadOnly, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = null);

Parameters

ConfigurationSetting setting The ConfigurationSetting to update.

System.Boolean isReadOnly If true, the ConfigurationSetting will be set to read only in the configuration store. If false, it will be set to read write.

System.Boolean onlyIfUnchanged If set to true and the configuration setting exists in the configuration store, update the setting if the passed-in ConfigurationSetting is the same version as the one in the configuration store. The setting versions are the same if their ETag fields match. If the two settings are different versions, this method will throw an exception to indicate that the setting in the configuration store was modified since it was last obtained by the client.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

Azure.Response<ConfigurationSetting>

SetReadOnly(String, String, Boolean, CancellationToken)

Sets an existing ConfigurationSetting to read only or read write state in the configuration store.

Declaration

public virtual Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting> SetReadOnly (string key, string label, bool isReadOnly, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String key The primary identifier of the configuration setting.

System.String label A label used to group this configuration setting with others.

System.Boolean isReadOnly If true, the ConfigurationSetting will be set to read only in the configuration store. If false, it will be set to read write.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

Azure.Response<ConfigurationSetting>

SetReadOnlyAsync(String, Boolean, CancellationToken)

Sets an existing ConfigurationSetting to read only or read write state in the configuration store.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting>> SetReadOnlyAsync (string key, bool isReadOnly, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String key The primary identifier of the configuration setting.

System.Boolean isReadOnly If true, the ConfigurationSetting will be set to read only in the configuration store. If false, it will be set to read write.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

System.Threading.Tasks.Task<Azure.Response<ConfigurationSetting>>

SetReadOnlyAsync(ConfigurationSetting, Boolean, Boolean, CancellationToken)

Sets an existing ConfigurationSetting to read only or read write state in the configuration store.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting>> SetReadOnlyAsync (Azure.Data.AppConfiguration.ConfigurationSetting setting, bool isReadOnly, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = null);

Parameters

ConfigurationSetting setting The ConfigurationSetting to update.

System.Boolean isReadOnly If true, the ConfigurationSetting will be set to read only in the configuration store. If false, it will be set to read write.

System.Boolean onlyIfUnchanged If set to true and the configuration setting exists in the configuration store, update the setting if the passed-in ConfigurationSetting is the same version as the one in the configuration store. The setting versions are the same if their ETag fields match. If the two settings are different versions, this method will throw an exception to indicate that the setting in the configuration store was modified since it was last obtained by the client.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

System.Threading.Tasks.Task<Azure.Response<ConfigurationSetting>>

SetReadOnlyAsync(String, String, Boolean, CancellationToken)

Sets an existing ConfigurationSetting to read only or read write state in the configuration store.

Declaration

[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Data.AppConfiguration.ConfigurationSetting>> SetReadOnlyAsync (string key, string label, bool isReadOnly, System.Threading.CancellationToken cancellationToken = null);

Parameters

System.String key The primary identifier of the configuration setting.

System.String label A label used to group this configuration setting with others.

System.Boolean isReadOnly If true, the ConfigurationSetting will be set to read only in the configuration store. If false, it will be set to read write.

System.Threading.CancellationToken cancellationToken A System.Threading.CancellationToken controlling the request lifetime.

Returns

System.Threading.Tasks.Task<Azure.Response<ConfigurationSetting>>

ToString()

Creates a Key Value string in reference to the ConfigurationSetting.

Declaration

[System.ComponentModel.EditorBrowsable]
public override string ToString ();

Returns

System.String

UpdateSyncToken(String)

Adds an external synchronization token to ensure service requests receive up-to-date values.

Declaration

public virtual void UpdateSyncToken (string token);

Parameters

System.String token The synchronization token value.