SALES: 1-800-867-1380

config module

Provides access to mobile service-specific configuration settings in Windows Azure Mobile Services

This object contains the following members:

Properties

The following configuration properties for the mobile service are accessed from this module.

 

Name Returns Description

applicationKey

string

The application key for the mobile service, which is distributed with the application. Because this key is not encrypted, it cannot be considered secure. To secure access to you mobile service data, you must instead authenticate users before allowing accessing. For more information, see Manage keys.

appSettings

JSON object

A JSON object of custom key-value pairs defined in the mobile service. These settings are used to securely store credentials for other Windows Azure and third-party services. For more information, see App settings.

crossDomainWhitelist

string

The names of the hosts that are permitted to make cross-domain calls to the mobile service. The host names are returned as a string representation of an array of JSON objects, one for each pair. For more information, see Cross-origin resource sharing.

dynamicSchemaEnabled

string

A Boolean value that is True when dynamic schema is enabled; otherwise False. For more information, see Dynamic schema.

facebookAppID

string

The app ID registered when using the Facebook identity provider for authentication. For more information, see Configure identity.

facebookAppSecret

string

The secret for the app ID registered when using the Facebook identity provider for authentication. For more information, see Configure identity.

googleClientID

string

The client ID registered when using the Google identity provider for authentication. For more information, see Configure identity.

googleClientSecret

string

The client secret registered when using the Google identity provider for authentication. For more information, see Configure identity.

masterKey

string

The service master key for you mobile service.

securitySecurity Note
This key is an important secret that provides administrator access to your mobile service and data. It is accessible in plain text on the config module and should not be returned to client apps. For more information, see Manage keys. For more information, see Manage keys. For more information, see Manage keys.

mobileServiceName

string

The name of the mobile service instance.

sqlConnectionString

string

The connection string used to access the Windows Azure SQL Database used by the mobile service. This string includes credentials used to access the service and is accessible in plain text on the config module.

twitterConsumerKey

string

The consumer key registered when using the Twitter identity provider for authentication. For more information, see Configure identity.

twitterConsumerSecret

string

The secret for the consumer key registered when using the Twitter identity provider for authentication. For more information, see Configure identity.

The following custom API example uses the supplied service object to retrieve an app setting value:

exports.get = function(request, response) {
    // Get the MY_CUSTOM_SETTING value from app settings.
    var customSetting = 
        request.service.config.appSettings.my_custom_setting;

    // Do something and then send a response.
}

The following code uses the configuration module to access Twitter credentials, stored in app settings, that is used in a scheduled job script:

// Get the app settings from the service configuration module.
var settings = require('mobileservice-config').appSettings;

// Get your Twitter v1.1 access credentials from app settings.
var consumerKey = settings.TWITTER_CONSUMER_KEY,
    consumerSecret = settings.TWITTER_CONSUMER_SECRET,
    accessToken= settings.TWITTER_ACCESS_TOKEN,
    accessTokenSecret = settings.TWITTER_ACCESS_TOKEN_SECRET;

In a service operation, the config module is accessed from the service object. Because the config module is not available in table operation and scheduled job scripts, you must require the configuration module to access your mobile service configuration.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft