RoleEnvironment.Changed Event

  • Article

 

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

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

Syntax

public static event EventHandler<RoleEnvironmentChangedEventArgs> Changed

public:
event EventHandler<RoleEnvironmentChangedEventArgs^>^ Changed {
    static void add(EventHandler<RoleEnvironmentChangedEventArgs^>^ value);
    static void remove(EventHandler<RoleEnvironmentChangedEventArgs^>^ value);
}

static member Changed : IEvent<EventHandler<RoleEnvironmentChangedEventArgs>,
    RoleEnvironmentChangedEventArgs>

Public Shared Event Changed As EventHandler(Of RoleEnvironmentChangedEventArgs)

Remarks

The Changed event and the Changing event are used together to identify and manage configuration changes to the service model. The RoleEnvironmentChangedEventArgs object provides the settings that were changed in the service configuration. You can use the Changing event to decide when the changes are applied.

The following code example shows how to write the list of configuration changes that were made to the role instance when the Changed event is raised:

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) 
   {
      Trace.WriteLine("Setting: " + settingChange.ConfigurationSettingName, "Information");
   }
}

See Also

RoleEnvironmentConfigurationSettingChange
RoleEnvironment Class
Microsoft.WindowsAzure.ServiceRuntime Namespace

Return to top