FeatureFlagConfigurationSetting Class

Definition

Namespace:

Azure.Data.AppConfiguration

Assembly:

Azure.Data.AppConfiguration.dll

Package:

Azure.Data.AppConfiguration v1.5.0

Source:

FeatureFlagConfigurationSetting.cs

Represents a configuration setting that stores a feature flag value. Feature flags allow you to activate or deactivate functionality in your application. A simple feature flag is either on or off. The application always behaves the same way. For example, you could roll out a new feature behind a feature flag. When the feature flag is enabled, all users see the new feature. Disabling the feature flag hides the new feature.

In contrast, a conditional feature flag allows the feature flag to be enabled or disabled dynamically. The application may behave differently, depending on the feature flag criteria. Suppose you want to show your new feature to a small subset of users at first. A conditional feature flag allows you to enable the feature flag for some users while disabling it for others. Feature filters determine the state of the feature flag each time it's evaluated.

NOTE: The Azure.Data.AppConfiguration doesn't evaluate feature flags on retrieval. It's the responsibility of the library consumer to interpret feature flags and determine whether a feature is enabled.

public class FeatureFlagConfigurationSetting : Azure.Data.AppConfiguration.ConfigurationSetting

type FeatureFlagConfigurationSetting = class
    inherit ConfigurationSetting

Public Class FeatureFlagConfigurationSetting
Inherits ConfigurationSetting

Inheritance

Object

ConfigurationSetting

FeatureFlagConfigurationSetting

Constructors

FeatureFlagConfigurationSetting(String, Boolean, String, ETag)	Initializes an instance of the FeatureFlagConfigurationSetting using a provided feature id and the enabled value.
FeatureFlagConfigurationSetting(String, Boolean, String)	Initializes an instance of the FeatureFlagConfigurationSetting using a provided feature id and the enabled value.

Properties

ClientFilters	Filters that must run on the client and be evaluated as true for the feature to be considered enabled.
ContentType	The content type of the configuration setting's value. Providing a proper content-type can enable transformations of values when they are retrieved by applications. (Inherited from ConfigurationSetting)
Description	Gets or sets a description of the feature.
DisplayName	Gets or sets a display name for the feature to use for display rather than the ID.
ETag	An ETag indicating the state of a configuration setting within a configuration store. (Inherited from ConfigurationSetting)
FeatureId	Gets or sets an ID used to uniquely identify and reference the feature
IsEnabled	Gets or sets a value indicating whether the features is enabled. A feature is OFF if enabled is false. If enabled is true, then the feature is ON if there are no conditions or if all conditions are satisfied.
IsReadOnly	A value indicating whether the configuration setting is read only. A read only configuration setting may not be modified until it is made writable. (Inherited from ConfigurationSetting)
Key	The primary identifier of the configuration setting. A Key is used together with a Label to uniquely identify a configuration setting. (Inherited from ConfigurationSetting)
KeyPrefix	The prefix used for FeatureFlagConfigurationSetting setting keys.
Label	A value used to group configuration settings. A Label is used together with a Key to uniquely identify a configuration setting. (Inherited from ConfigurationSetting)
LastModified	The last time a modifying operation was performed on the given configuration setting. (Inherited from ConfigurationSetting)
Tags	A dictionary of tags used to assign additional properties to a configuration setting. These can be used to indicate how a configuration setting may be applied. (Inherited from ConfigurationSetting)
Value	The configuration setting's value. (Inherited from ConfigurationSetting)