Update Disk
The Update Disk operation updates the label of an existing disk in the image repository that is associated with the specified subscription.
Request
The Update Disk request may be specified as follows. Replace <subscription-id> with the subscription ID and <disk-name> with the name of the disk being updated.
Method |
Request URI |
|---|---|
PUT |
https://management.core.windows.net/<subscription-id>/services/disks/<disk-name> |
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
<Disk xmlns="https://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Name>name-of-disk</Name>
<Label>description-of-disk</Label>
<ResizedSizeInGB>resized-size-in-GB</ResizedSizeInGB>
</Disk>
The following table describes the elements of the request body.
Element name |
Description |
|---|---|
Name |
Required. Specifies the name of the disk to update. This element is only used to identify the disk for which the label should be updated and cannot be changed. |
Label |
Optional. Specifies the label of the disk that is to be updated. |
ResizedSizeInGB |
Optional. Resizes the underlying blob to the indicated size in GB. To use the ResizedSizeInGB property, the version header should be at least 2014-10-01. |
Response
The response includes an HTTP status code and a set of response headers.
Status Code
If ResizedSizeInGB is not used, then the API completes synchronously and returns HTTP 200 (OK) if successful. If ResizedSizeInGB is specified, the API returns HTTP 202 (Accepted) and executes asynchronously. Then one must poll on the status of the API using Get Operation Status.
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
The updated Disk as XML.
Remarks
Disks can only be resized to a larger size, they cannot be shrunk. The size in GB cannot include decimals.
To resize a disk, it must not be attached to a running VM. You can stop the machine without detaching the disk.
An error may occur if the disk cannot be resized. Retry the update operation with the same or larger value to recover the disk.