Home Library Learn Downloads Support Community
Sign in | United States - English | |
2 out of 3 rated this helpful - Rate this topic

RoleEnvironment.GetConfigurationSettingValue Method

Retrieves the value of a setting in the service configuration file.

Namespace: Microsoft.WindowsAzure.ServiceRuntime
Assembly: Microsoft.WindowsAzure.ServiceRuntime (in Microsoft.WindowsAzure.ServiceRuntime.dll)
VB
Copy 
'Usage
Dim configurationSettingName As String
Dim returnValue As String

returnValue = RoleEnvironment.GetConfigurationSettingValue(configurationSettingName)
C#
C++
VB
Copy 
[SecurityPermissionAttribute(SecurityAction.Assert, UnmanagedCode=true)] 
public static string GetConfigurationSettingValue (
	string configurationSettingName
)
J#
Copy 
/** @attribute SecurityPermissionAttribute(SecurityAction.Assert, UnmanagedCode=true) */ 
public static String GetConfigurationSettingValue (
	String configurationSettingName
)
JScript
Copy 
public static function GetConfigurationSettingValue (
	configurationSettingName : String
) : String

Parameters

configurationSettingName

Type: System.String

The name of the configuration setting.

Return Value

Type: System.String

A String that contains the value of the configuration setting.
Exception type Condition
RoleEnvironmentException

The configuration setting that was being retrieved does not exist.

Configuration settings for a role are defined in the ServiceDefinition.csdef file and the values for the settings are configured in the ServiceConfiguration.cscfg file. For more information about defining and configuring settings, see the following information:

The GetConfigurationSettingValue method can be used to retrieve the value that is defined in the ServiceConfiguration.cscfg file. The following code example shows how to get and write out the value for a setting called MySetting:

C#
Copy 

var settingValue = RoleEnvironment.GetConfigurationSettingValue("MySetting"); 
Trace.WriteLine("The setting value is: " + settingValue, "Information");

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

Development Platforms

Windows Vista, Windows 7 and Windows Server 2008

Target Platforms

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Thank you for your feedback
Thank you for your feedback. The topic has been updated and a new version will be published soon.
History
Conflicting settings locations
The Remarks section above states two file names for the settings:
"settings are configured in the ServiceConfiguration.cscfg file."
"used to retrieve the value that is defined in the ServiceDefinintion.cscfg file."
History
What is service definition file?
service definition file = ServiceDefinition.csdef
History
What if the setting is not found
This document does not explain what happens when the setting is not found.  I found that it returns a Microsoft.WindowsAzure.ServiceRuntime.RoleEnvironmentException whose message consists entirely of "error" :/

History
What and where is the service definition file in an Azure project?
This documentation is too vague. What is the "service definition file?" Is it Web.config? Is it app.config? If so, the app.config files and Web.config files are huge and there are many different places where a setting could be placed. Need specific information and direct, concrete, task-oriented sample code.

"A role's configuration settings are defined in the service definition file. Values for configuration settings are set in the service configuration file"
History