SalesBuy
1-855-856-7678
Technical SupportSupport
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.
Shutdown Role
The Shutdown Role operation shuts down the specified virtual machine.
Request
The Shutdown Role request is specified as follows. Replace <subscription-id> with your subscription ID, <service-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 |
|---|---|---|
|
POST |
|
HTTP/1.1 |
URI Parameters
None.
Request Headers
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. Currently this header should be set to 2012-03-01. |
Request Body
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>
</ShutdownRoleOperation>
The following table describes the key elements of the request body:
| Element name | Description |
|---|---|
|
OperationType |
Required. Specifies the operation to be performed. The value must be set to ShutdownRoleOperation. |
Response
The response includes an HTTP status code and a set of response headers.
Status Code
A successful operation returns status code 201 (Created).
For information about status codes, see Service Management Status and Error Codes.
Response Headers
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.
| Response Header | Description |
|---|---|
|
x-ms-request-id |
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. |
Response Body
None.
Authorization
Only the account owner may call this operation.
