RoleEnvironmentConfigurationSettingChange Class

Article
08/18/2015

Represents a change to the configuration of a role.

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

Inheritance Hierarchy

System.Object
Microsoft.WindowsAzure.ServiceRuntime.RoleEnvironmentChange
Microsoft.WindowsAzure.ServiceRuntime.RoleEnvironmentConfigurationSettingChange

Syntax

public class RoleEnvironmentConfigurationSettingChange : RoleEnvironmentChange, 
    IEquatable<RoleEnvironmentConfigurationSettingChange>

public ref class RoleEnvironmentConfigurationSettingChange : RoleEnvironmentChange, 
    IEquatable<RoleEnvironmentConfigurationSettingChange^>

type RoleEnvironmentConfigurationSettingChange = 
    class
        inherit RoleEnvironmentChange
        interface IEquatable<RoleEnvironmentConfigurationSettingChange>
    end

Public Class RoleEnvironmentConfigurationSettingChange
    Inherits RoleEnvironmentChange
    Implements IEquatable(Of RoleEnvironmentConfigurationSettingChange)

Properties

	Name	Description
	ConfigurationSettingName	Gets the name of the configuration setting that has been changed.

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object.(Overrides Object.Equals(Object).)
	Equals(RoleEnvironmentConfigurationSettingChange)	Determines whether the specified RoleEnvironmentConfigurationSettingChange object is equal to the current object.
	Finalize()	(Inherited from Object.)
	GetHashCode()	Retrieves the hash code that corresponds to the current object.(Overrides Object.GetHashCode().)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

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.