Shutdown Roles
Updated: July 10, 2015
The Shutdown Roles operation shuts down multiple Virtual Machines.
The Shutdown Roles request may be specified as follows. Replace <subscription-id> with the subscription ID, <cloudservice-name> with the name of the cloud service, and <deployment-name> with the name of the deployment.
Method | Request URI |
|---|---|
POST | https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deployments/<deployment-name>/roles/Operations |
None.
The following table describes the request headers.
Request Header | Description |
|---|---|
x-ms-version | Required. Specifies the version of the operation to use for this request. This header should be set to 2013-06-01 or higher. |
The format of the request body is as follows:
<ShutdownRolesOperation xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<OperationType>ShutdownRolesOperation</OperationType>
<Roles>
<Name>name-of-virtual-machine</Name>
</Roles>
<PostShutdownAction>shutdown-action</PostShutdownAction>
</ShutdownRolesOperation>
The following table describes the elements of the request body.
Element name | Description |
|---|---|
OperationType | Required. Specifies the operation to be performed. The value must be set to ShutdownRolesOperation. |
Roles | Required. Contains a list of names of Virtual Machines to shut down. |
Name | Required. Specifies the name of a Virtual Machine to shut down. |
PostShutdownAction | Required. Specifies how the Virtual Machine should be shut down. Possible values are:
|
The response includes an HTTP status code and a set of response headers.
A successful operation returns status code 202 (Accepted).
The response for this operation includes the following headers. The response may also include additional standard HTTP headers.
Response Header | Description |
|---|---|
x-ms-request-id | A value that uniquely identifies a request made against the management service. |
None.