Share via

RoleEnvironment.RequestRecycle Method ()

  • Article

 

Requests that the current role instance be stopped and restarted.

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

Syntax

public static void RequestRecycle()

public:
static void RequestRecycle()

static member RequestRecycle : unit -> unit

Public Shared Sub RequestRecycle

Exceptions

Exception Condition
RoleEnvironmentException

The role instance could not be stopped and restarted.

Remarks

When the RequestRecycle method is called, the load balancer takes the role instance out of the rotation and the normal shutdown cycle is initiated. New requests are not routed to the role instance while it is restarting.

Windows Azure raises the Stopping event and calls the OnStop method where you can run the necessary code to prepare the role instance to be recycled.

See Also

RoleEnvironment Class
Microsoft.WindowsAzure.ServiceRuntime Namespace

Return to top