Reset-AzureRoleInstance

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Reset-AzureRoleInstance

Requests a reboot or reimage of a single role instance or all role instances of a specific role.

Parameter Set: ParameterSetGetDeployment
Reset-AzureRoleInstance [-ServiceName] <String> -InstanceName <String> -Slot <String> [-Reboot] [-Reimage] [ <CommonParameters>]

This topic describes the cmdlet in the .6.19 version of the Windows Azure PowerShell module. To find out the version of the module you're using, from the Windows Azure PowerShell console, type (get-module azure).version.

The ReSet-AzureRoleInstance cmdlet requests a reboot or a reimage of a role instance that is running in a deployment. This operation executes synchronously.

When you reboot a role instance, Windows Azure takes the instance offline, restarts the underlying operating system for that instance, and brings the instance back online. Any data that is written to the local disk persists across reboots. Any data that is in-memory is lost.

Reimaging a role instance results in different behavior depending on the type of role. For a web or worker role, when the role is reimaged, Windows Azure takes the role offline and writes a fresh installation of the Windows Azure guest operating system to the virtual machine. The role is then brought back online. For a VM role, when the role is reimaged, Windows Azure takes the role offline, reapplies the custom image that you provided for it, and brings the role back online.

Windows Azure attempts to maintain data in any local storage resources when the role is reimaged; however, in case of a transient hardware failure, the local storage resource may be lost. If your application requires that data persist, writing to a durable data source, such as a Windows Azure drive, is recommended. Any data that is written to a local directory other than that defined by the local storage resource will be lost when the role is reimaged.

-InstanceName<String>

Specifies the name of the role instance to reimage or reboot.

-Reboot

If this parameter is specified, reboots the specified role instance or, if none is specified, all role instances. You must include either a Reboot or Reimage parameter, but not both.

-Reimage

If this parameter is specified, reimages the specified role instance or, if none is specified, all role instances. You must include either a Reboot or Reimage parameter, but not both.

-ServiceName<String>

Specifies the name of the service.

-Slot<String>

The deployment environment where the role instances are running. Supported values are "Production" and "Staging". You can include either a DeploymentName or Slot parameter, but not both.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

-------------- Example 1 --------------

This command reboots the "MyWebRole_IN_0" role instance in the staging deployment of the "MySvc1" service.

C:\PS>ReSet-AzureRoleInstance -ServiceName "MySvc1" -Slot Staging -InstanceName "MyWebRole_IN_0" –reboot

-------------- Example 2 --------------

This command reimages the role instances in the staging deployment of the MyTodo cloud service.

C:\PS>ReSet-AzureRoleInstance -ServiceName "MySvc1" -Slot Staging  –Reimage 

-------------- Example 3 --------------

This command reimages all role instances in the production deployment of the "MySvc1" service.

C:\PS>ReSet-AzureRoleInstance -ServiceName "MySvc1" -Slot "Production  –Reimage