Share via

Shutdown Role

  • Article

 

The Shutdown Role operation shuts down the specified Virtual Machine.

Request

The Shutdown Role request may be specified as follows. Replace <subscription-id> with the subscription ID, <cloudservice-name> with the name of the cloud service, <deployment-name> with the name of the deployment, and <role-name> with the name of the Virtual Machine.

Method

Request URI

POST

https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deployments/<deployment-name>/roleinstances/<role-name>/Operations

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. This header should be set to 2012-03-01 or higher.

Request Body

The format of the request body is as follows:

<ShutdownRoleOperation xmlns="https://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 elements of the request body.

Element name

Description

OperationType

Required. Specifies the operation to be performed.

The value must be set to ShutdownRoleOperation.

PostShutdownAction

Optional. Specifies how the Virtual Machine should be shut down.

Possible values are:

  • Stopped – shuts down the Virtual Machine but retains the compute resources. You will continue to be billed for the resources that the stopped machine uses.

  • StoppedDeallocated – shuts down the Virtual Machine and releases the compute resources. You are not billed for the compute resources that this Virtual Machine uses. If a static Virtual Network IP address is assigned to the Virtual Machine, it is reserved.

    The PostShutdownAction element is only available using version 2013-06-01 or higher.

If this element is not specified, the default action is Stopped.

Response

The response includes an HTTP status code and a set of response headers.

Status Code

A successful operation returns status code 202 (Accepted).

Response Headers

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.

Response Body

None.