SALES: 1-800-867-1380

Shutdown Role

Updated: April 15, 2015

The Shutdown Role operation shuts down the specified Virtual Machine.

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


You must make sure that the request that is made to the management service is secure. For additional details, see Authenticating Service Management Requests.

The following table describes the request headers.


Request Header Description


Required. Specifies the version of the operation to use for this request. This header should be set to 2012-03-01 or higher. For more information about versioning headers, see Service Management Versioning.

The format of the request body is as follows:

<ShutdownRoleOperation xmlns="" xmlns:i="">

The following table describes the elements of the request body.


Element name Description


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:

  • 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. For more information, see StaticVirtualNetworkIPAddress in Get Role.

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

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.


Response Header Description


A value that uniquely identifies a request made against the management service.

You can also shut down a Virtual Machine by using the Management Portal or by using the Stop-AzureVM cmdlet.

If you are shutting down the last running Virtual Machine in the deployment with a PostShutdownAction of StoppedDeallocated and the deployment is using a reserved IP address, the address continues to be reserved for your subscription. The unused reserved IP address continues to incur charges. For more information, see Reserved IP Pricing. To delete the reserved IP address if you don’t need it anymore, use Delete Reserved IP Address.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft