RoleInstanceStatusCheckEventArgs Class


Represents the arguments for the StatusCheck event, which occurs at a regular interval to indicate the status of a role instance.

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

Inheritance Hierarchy



public class RoleInstanceStatusCheckEventArgs : EventArgs
public ref class RoleInstanceStatusCheckEventArgs : EventArgs
type RoleInstanceStatusCheckEventArgs = 
        inherit EventArgs
Public Class RoleInstanceStatusCheckEventArgs
    Inherits EventArgs


Name Description
System_CAPS_pubmethod RoleInstanceStatusCheckEventArgs()

Initializes a new instance of the RoleInstanceStatusCheckEventArgs class.


Name Description
System_CAPS_pubproperty Status

Gets the status of the role instance.


Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod SetBusy()

Sets the status of the role instance to Busy until the status is checked again, which occurs at regular intervals. When the status of the role instance is Busy it will not receive requests from the load balancer.

System_CAPS_pubmethod ToString()

(Inherited from Object.)


A role instance may indicate that it is in one of two states: Ready or Busy. If the state of a role instance is Ready, it is prepared to receive requests from the load balancer. If the state of the instance is Busy, it will not receive requests from the load balancer.

The following code example shows how to write out the status of the role instance:

public override bool OnStart()
   RoleEnvironment.StatusCheck += RoleEnvironmentStatusCheck;

   return base.OnStart();

private void RoleEnvironmentStatusCheck(object sender, RoleInstanceStatusCheckEventArgs e)
   Trace.WriteLine("The status of the role instance: " + e.Status, "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