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

RoleEnvironment.StatusCheck Event

Updated: December 6, 2013

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)
Public Shared Event StatusCheck As EventHandler(Of RoleInstanceStatusCheckEventArgs)

You can use the StatusCheck event to change the status of the role instance. 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. By calling the SetBusy method of RoleInstanceStatusCheckEventArgs, you can temporarily set the status of the role instance to Busy, which removes the role instance from the load balancer.

The following code example shows how to set the status of the role instance to Busy:

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

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012

Target Platforms