Duration (Pacific Standard Time):
To (Pacific Standard Time):
Impact:
  • None
User Action:
  • None

RoleEnvironment Class

 

Updated: December 6, 2013

Provides information about the configuration, endpoints, and status of running role instances.

Namespace:   Microsoft.WindowsAzure.ServiceRuntime
Assembly:  Microsoft.WindowsAzure.ServiceRuntime (in Microsoft.WindowsAzure.ServiceRuntime.dll)

System.Object
  Microsoft.WindowsAzure.ServiceRuntime.RoleEnvironment

<WindowsAzureHostingPermissionAttribute(SecurityAction.LinkDemand,
	Unrestricted := True)>
Public NotInheritable Class RoleEnvironment
Name Description
System_CAPS_pubproperty System_CAPS_static CurrentRoleInstance

Gets a RoleInstance object that represents the role instance in which the code is currently running.

System_CAPS_pubproperty System_CAPS_static DeploymentId

Gets the unique identifier of the deployment in which the role instance is running.

System_CAPS_pubproperty System_CAPS_static IsAvailable

Indicates whether the role instance is running in the Windows Azure environment.

System_CAPS_pubproperty System_CAPS_static IsEmulated

Indicates whether the role instance is running in the Microsoft Azure compute emulator.

System_CAPS_pubproperty System_CAPS_static Roles

Gets the set of Role objects defined for the hosted service.

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod System_CAPS_static GetConfigurationSettingValue(String)

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

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod System_CAPS_static GetLocalResource(String)

Retrieves a specified local storage resource.

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod System_CAPS_static RequestRecycle()

Requests that the current role instance be stopped and restarted.

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Name Description
System_CAPS_pubfield System_CAPS_static TraceSource

Name Description
System_CAPS_pubevent System_CAPS_static Changed

Occurs after a change to the service configuration is applied to the running instances of a role.

System_CAPS_pubevent System_CAPS_static Changing

Occurs before a change to the service configuration is applied to the running instances of a role.

System_CAPS_pubevent System_CAPS_static SimultaneousChanged

Occurs after a simultaneous change to the service configuration has been applied to the running instances of a role. A simultaneous change affects all role instances at the same time.

System_CAPS_pubevent System_CAPS_static SimultaneousChanging

Occurs before a simultaneous change to the service configuration is applied to the running instances of a role. A simultaneous change affects all role instances at the same time.

System_CAPS_pubevent System_CAPS_static StatusCheck

Occurs at a regular interval to indicate the status of a role instance.

System_CAPS_pubevent System_CAPS_static Stopping

Occurs when a role instance is about to be stopped.

You use the RoleEnvironment class to obtain configuration settings, local storage resources, and endpoint information for a specified role instance. The class also provides events that allow the role instance to react to configuration changes and receive notification when the role instance is about to be stopped.

System_CAPS_note Note

Windows Azure 1.3 and later reserves for its own use any environment variables that begin with the letters "RD", for example "RdRoleID". If your application creates environment variables that begin with "RD", in certain circumstances, the IsAvailable property will return false, and other methods and properties of the RoleEnvironment class will result in the error message "role discovery data is unavailable." To correct this, use environment variables that do not begin with the letters "RD".

System_CAPS_note Note

The RoleEnvironment class can be used on standalone components in an Azure VM outside of an Azure role. These components can be programs that can be run by, for example, remoting into the role instance and starting the component from the command line. These processes must be run with elevated privileges to access the RoleEnvironment class.

The following code example shows how to get and write out the value for a configuration setting called MySetting by using the GetConfigurationSettingValue method:

No code example is currently available or this language may not be supported.

For more information about defining and configuring settings, see Windows Azure Service Configuration Schema and Windows Azure Service Definition Schema.

The following code example shows how to retrieve a local storage resource and write a text file to it:

No code example is currently available or this language may not be supported.

The following code example shows how to retrieve endpoint information for the current role instance:

No code example is currently available or this language may not be supported.

The following code example shows how to retrieve the configuration changes that have been made to a role instance:

No code example is currently available or this language may not be supported.

The events are only raised if an internal endpoint is defined for the role in the ServiceDefinition.csdef file. For more information about defining endpoints, see .3c806d3f-e335-4b1e-8a03-115bae2b3aab

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

Return to top