Get Data Disk

  • Article

 

The Get Data Disk operation retrieves the specified data disk from a Virtual Machine.

Request

The Get Data Disk request may be specified as follows. Replace <subscription-id> with the subscription ID, <service-name> with the name of the cloud service, <deployment-name> with the name of the deployment, and <lun> with the logical unit number of the disk.

Method

Request URI

GET

https://management.core.windows.net/<subscription-id>/services/hostedservices/<service-name>/deployments/<deployment-name>/roles/<role-name>/DataDisks/<lun>

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

None.

Response

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

Status Code

A successful operation returns status code 200 (OK).

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 format of the response body is as follows:

<DataVirtualHardDisk xmlns="https://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <HostCaching>caching-mode</HostCaching>
  <DiskLabel>identifier-of-disk</DiskLabel>
  <DiskName>name-of-disk</DiskName> 
  <Lun>lun</Lun>
  <LogicalDiskSizeInGB>size-in-gb-of-disk</LogicalDiskSizeInGB>
  <MediaLink>uri-of-vhd</MediaLink>
</DataVirtualHardDisk>
<IOType>IO-type<IOType>

The following table describes the elements of the response body.

Element name

Description

HostCaching

Specifies the caching behavior of the data disk.

Possible values are:

  • None

  • ReadOnly

  • ReadWrite

DiskLabel

Specifies the identifier of the data disk. This value is only available programmatically and is not shown in the Management Portal.

DiskName

Specifies the name of the disk.

Lun

Specifies the Logical Unit Number (LUN) for the disk.

Should be between 0 – 31.

LogicalDiskSizeInGB

Specifies the size, in GB, of the data disk.

MediaLink

Specifies the location of the blob in storage where the vhd file for the disk is located.

Example: http://contoso.blob.core.windows.net/disks/mydatadisk.vhd

IOType

Identifies the type of the storage account for the backing VHD. If the backing VHD is in an Provisioned Storage account, “Provisioned” is returned otherwise “Standard” is returned.

Note: This value is populated by Azure platform when the disk is created, not by the user.

This property is only returned with a version header of 2014-10-01 or newer.