The Shutdown Role operation shuts down the specified Virtual Machine.
The Shutdown Role request is specified as follows. Replace
<subscription-id> with your subscription ID,
<cloudservice-name> with the name of your service,
<deployment-name> with the name of the deployment, and
<role-name> with the name of the Virtual Machine to shut down.
|Method||Request URI||HTTP Version|
The following table describes the request headers.
Required. Specifies the version of the operation to use for this request. This header should be set to 2012-03-01 or higher.
The format of the request body is as follows:
<ShutdownRoleOperation xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <OperationType>ShutdownRoleOperation</OperationType> <PostShutdownAction>shutdown-action</PostShutdownAction> </ShutdownRoleOperation>
The following table describes the key elements of the request body:
Required. Specifies the operation to be performed.
The value must be set to ShutdownRoleOperation.
Optional. Specifies how the Virtual Machine should be shut down.
Possible values are:
If this element is not specified, the default action is Stopped.
The response includes an HTTP status code and a set of response headers.
A successful operation returns status code 202 (Accepted).
For information about status codes, see Service Management Status and Error Codes.
The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
A value that uniquely identifies a request made against the Management service. For an asynchronous operation, you can call get operation status with the value of the header to determine whether the operation is complete, has failed, or is still in progress. See Tracking Asynchronous Service Management Requests for more information.
Only the account owner may call this operation.
You can also shut down a Virtual Machine by using the Windows Azure Management Portal or by using the Stop-AzureVM cmdlet.