Class ConfigurationSetting
A setting, defined by a unique combination of a key and label.
Inheritance
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Data.AppConfiguration.dll
Syntax
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Data.AppConfiguration.ConfigurationSettingJsonConverter))]
public class ConfigurationSetting
Constructors
ConfigurationSetting(String, String, String)
Creates a configuration setting and sets the values from the passed in parameter to this setting.
Declaration
public ConfigurationSetting (string key, string value, string label = 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. |
ConfigurationSetting(String, String, String, ETag)
Creates a configuration setting and sets the values from the passed in parameter to this setting.
Declaration
public ConfigurationSetting (string key, string value, string label, Azure.ETag etag);
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. |
Azure.ETag
etag
The ETag value for the configuration setting. |
Properties
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.
Declaration
public string ContentType { get; set; }
Property Value
System.String
|
ETag
An ETag indicating the state of a configuration setting within a configuration store.
Declaration
public Azure.ETag ETag { get; }
Property Value
Azure.ETag
|
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.
Declaration
public Nullable<bool> IsReadOnly { get; }
Property Value
System.Nullable<System.Boolean>
|
Key
The primary identifier of the configuration setting. A Key is used together with a Label to uniquely identify a configuration setting.
Declaration
public string Key { get; set; }
Property Value
System.String
|
Label
A value used to group configuration settings. A Label is used together with a Key to uniquely identify a configuration setting.
Declaration
public string Label { get; set; }
Property Value
System.String
|
LastModified
The last time a modifying operation was performed on the given configuration setting.
Declaration
public Nullable<DateTimeOffset> LastModified { get; }
Property Value
System.Nullable<System.DateTimeOffset>
|
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.
Declaration
public System.Collections.Generic.IDictionary<string,string> Tags { get; }
Property Value
System.Collections.Generic.IDictionary<System.String,System.String>
|
Value
The configuration setting's value.
Declaration
public string Value { get; set; }
Property Value
System.String
|
Methods
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
|
GetHashCode()
Get a hash code for the ConfigurationSetting.
Declaration
[System.ComponentModel.EditorBrowsable]
public override int GetHashCode ();
Returns
System.Int32
|
ToString()
Creates a (Key,Value) string in reference to the ConfigurationSetting.
Declaration
[System.ComponentModel.EditorBrowsable]
public override string ToString ();
Returns
System.String
|