RoleEnvironmentConfigurationSettingChange Class


Represents a change to the configuration of a role.

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

Inheritance Hierarchy



public class RoleEnvironmentConfigurationSettingChange : RoleEnvironmentChange, 
public ref class RoleEnvironmentConfigurationSettingChange : RoleEnvironmentChange, 
type RoleEnvironmentConfigurationSettingChange = 
        inherit RoleEnvironmentChange
        interface IEquatable<RoleEnvironmentConfigurationSettingChange>
Public Class RoleEnvironmentConfigurationSettingChange
    Inherits RoleEnvironmentChange
    Implements IEquatable(Of RoleEnvironmentConfigurationSettingChange)


Name Description
System_CAPS_pubproperty ConfigurationSettingName

Gets the name of the configuration setting that has been changed.


Name Description
System_CAPS_pubmethod Equals(Object)

Determines whether the specified object is equal to the current object.(Overrides Object.Equals(Object).)

System_CAPS_pubmethod Equals(RoleEnvironmentConfigurationSettingChange)

Determines whether the specified RoleEnvironmentConfigurationSettingChange object is equal to the current object.

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

Retrieves the hash code that corresponds to the current object.(Overrides Object.GetHashCode().)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)


When you make a change to the configuration of a role and apply the changes to role instances, the changes are contained in RoleEnvironmentConfigurationSettingChange objects. The RoleEnvironmentConfigurationSettingChange objects only contain configuration changes that were made to role that corresponds to the currently running role instance.

For more information about defining the service model for a hosted service, see Setting Up a Hosted Service for Windows Azure.

The following code example shows how to use the RoleEnvironmentConfigurationSettingChange object to write out the changes:

public override bool OnStart() 
   RoleEnvironment.Changed += RoleEnvironmentChanged;

   return base.OnStart();

private void RoleEnvironmentChanged(object sender, RoleEnvironmentChangedEventArgs e)
   // Get the list of configuration changes
   var settingChanges = e.Changes.OfType<RoleEnvironmentConfigurationSettingChange>();

   foreach (var settingChange in settingChanges) 
      var message = "Setting: " + settingChange.ConfigurationSettingName;
      Trace.WriteLine(message, "Information");

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.

See Also

Microsoft.WindowsAzure.ServiceRuntime Namespace

Return to top