ServiceSettingsDictionary Class

Article
05/25/2016

Contains settings for a service such as the name, authentication provider information, connection strings, etc. The ServiceSettingsDictionary provides typed properties for known settings such as Name and Key as well as IDictionary<TKey, TValue> access for all other settings.

Namespace: Microsoft.WindowsAzure.Mobile.Service
Assembly: Microsoft.WindowsAzure.Mobile.Service (in Microsoft.WindowsAzure.Mobile.Service.dll)

Inheritance Hierarchy

System.Object
System.Collections.Generic.Dictionary<TKey, TValue>
Microsoft.WindowsAzure.Mobile.Service.ServiceSettingsDictionary

Syntax

[SerializableAttribute]
[DefaultMemberAttribute("Item")]
public class ServiceSettingsDictionary : Dictionary<string, string>

[SerializableAttribute]
[DefaultMemberAttribute("Item")]
public ref class ServiceSettingsDictionary : Dictionary<String^, String^>

[<SerializableAttribute>]
[<DefaultMemberAttribute("Item")>]
type ServiceSettingsDictionary = 
    class
        inherit Dictionary<string, string>
    end

<SerializableAttribute>
<DefaultMemberAttribute("Item")>
Public Class ServiceSettingsDictionary
    Inherits Dictionary(Of String, String)

Constructors

	Name	Description
	ServiceSettingsDictionary()	Initializes a new instance of the ServiceSettingsDictionary class.
	ServiceSettingsDictionary(SerializationInfo, StreamingContext)	Initializes a new instance of the ServiceSettingsDictionary class with the specified serialization information and streaming context.

Properties

	Name	Description
	AzureActiveDirectoryAudience	Gets or sets the Azure Active Directory audience used for token validation.
	AzureActiveDirectoryClientId	Gets or sets the Azure Active Directory client ID.
	AzureActiveDirectoryTenants	Gets or sets a comma separated list of allowed AAD tenants. These should be specified as tenant domain names.
	Comparer	(Inherited from Dictionary<TKey, TValue>.)
	Connections	Gets the set of connection strings for the service.
	Count	(Inherited from Dictionary<TKey, TValue>.)
	CrossDomainOrigins	Gets or sets a comma-separated list of origins that are allowed to access the resource.
	FacebookAppId	Gets or sets the Facebook ID associated with this service.
	FacebookSecret	Gets or sets the Facebook secret associated with this service.
	GoogleAppId	Gets or sets the Google application ID associated with this service.
	GoogleSecret	Gets or sets the Google secret associated with this service.
	IsAzureActiveDirectoryAuthenticationEnabled	Gets a value indicating whether Azure Active Directory authentication is enabled for this service.
	IsFacebookAuthenticationEnabled	Gets a value indicating whether Facebook authentication is enabled for this service.
	IsGoogleAuthenticationEnabled	Gets a value indicating whether Google authentication is enabled for this service.
	IsMicrosoftAccountAuthenticationEnabled	Gets a value indicating whether Microsoft Account authentication is enabled for this service.
	IsTwitterAuthenticationEnabled	Gets a value indicating whether Twitter authentication is enabled for this service.
	Item[String]	Gets or sets the value associated with the specified key.
	Key	Gets or sets the service key (a.k.a. application key).
	Keys	(Inherited from Dictionary<TKey, TValue>.)
	MasterKey	Gets or sets the application master key.
	MicrosoftAccountClientId	Gets or sets the Microsoft Account client ID associated with this service.
	MicrosoftAccountClientSecret	Gets or sets the Microsoft Account client secret associated with this service.
	Name	Gets or sets the name of the service.
	NotificationHubName	Gets or sets the name of the Notification Hub associated with this service for handling push notifications.
	Schema	Gets or sets the default database schema name. This default database schema name is used for database objects that do not have an explicitly configured schema name.
	SubscriptionId	Gets or sets the SubscriptionId of the service.
	TwitterConsumerKey	Gets or sets the Twitter consumer key associated with this service.
	TwitterConsumerSecret	Gets or sets the Twitter consumer secret associated with this service.
	Values	(Inherited from Dictionary<TKey, TValue>.)

Methods

	Name	Description
	Add(TKey, TValue)	(Inherited from Dictionary<TKey, TValue>.)
	Clear()	(Inherited from Dictionary<TKey, TValue>.)
	ContainsKey(TKey)	(Inherited from Dictionary<TKey, TValue>.)
	ContainsValue(TValue)	(Inherited from Dictionary<TKey, TValue>.)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetEnumerator()	(Inherited from Dictionary<TKey, TValue>.)
	GetHashCode()	(Inherited from Object.)
	GetObjectData(SerializationInfo, StreamingContext)	(Inherited from Dictionary<TKey, TValue>.)
	GetSchemaName()	Gets the Database schema name from configuration. If an application setting with the key MS_TableSchema is set then that is used. Otherwise, if a setting with the key MS_MobileServiceName with set then that is used.
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	OnDeserialization(Object)	(Inherited from Dictionary<TKey, TValue>.)
	Remove(TKey)	(Inherited from Dictionary<TKey, TValue>.)
	ToString()	(Inherited from Object.)
	TryGetValue(TKey, TValue)	(Inherited from Dictionary<TKey, TValue>.)

Explicit Interface Implementations

	Name	Description
	ICollection<KeyValuePair<TKey, TValue>>.Add(KeyValuePair<TKey, TValue>)	(Inherited from Dictionary<TKey, TValue>.)
	ICollection<KeyValuePair<TKey, TValue>>.Contains(KeyValuePair<TKey, TValue>)	(Inherited from Dictionary<TKey, TValue>.)
	ICollection<KeyValuePair<TKey, TValue>>.CopyTo(KeyValuePair<TKey, TValue>[], Int32)	(Inherited from Dictionary<TKey, TValue>.)
	ICollection<KeyValuePair<TKey, TValue>>.Remove(KeyValuePair<TKey, TValue>)	(Inherited from Dictionary<TKey, TValue>.)
	IEnumerable<KeyValuePair<TKey, TValue>>.GetEnumerator()	(Inherited from Dictionary<TKey, TValue>.)
	ICollection.CopyTo(Array, Int32)	(Inherited from Dictionary<TKey, TValue>.)
	IDictionary.Add(Object, Object)	(Inherited from Dictionary<TKey, TValue>.)
	IDictionary.Contains(Object)	(Inherited from Dictionary<TKey, TValue>.)
	IDictionary.GetEnumerator()	(Inherited from Dictionary<TKey, TValue>.)
	IDictionary.Remove(Object)	(Inherited from Dictionary<TKey, TValue>.)
	IEnumerable.GetEnumerator()	(Inherited from Dictionary<TKey, TValue>.)

Remarks

Any property values set on an instance will only stay in effect for the lifetime of the current AppDomain. To change the settings in a persistent manner, please update them using a mechanism provided by the service host.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.