Disks - Attach

Attach and create the lease of the disk to the virtual machine. This operation can take a while to complete.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}/attach?api-version=2018-09-15

URI Parameters

Name In Required Type Description
labName
path True

string

The name of the lab.

name
path True

string

The name of the disk.

resourceGroupName
path True

string

The name of the resource group.

subscriptionId
path True

string

The subscription ID.

userName
path True

string

The name of the user profile.

api-version
query True

string

Client API version.

Request Body

Name Type Description
leasedByLabVmId

string

The resource ID of the Lab virtual machine to which the disk is attached.

Responses

Name Type Description
200 OK

OK

202 Accepted

Accepted

Other Status Codes

CloudError

BadRequest

Security

azure_auth

OAuth2 Implicit Grant

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Access Microsoft Azure

Examples

Disks_Attach

Sample Request

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/users/{userId}/disks/{diskName}/attach?api-version=2018-09-15

{
  "leasedByLabVmId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualmachines/{vmName}"
}

Sample Response

location: https://management.azure.com/subscriptions/{subscriptionId}/resourceGroup/{resourceGroupName}/providers/Microsoft.DevTestLabs/locations/{location}

Definitions

Name Description
AttachDiskProperties

Properties of the disk to attach.

CloudError

Error from a REST request.

CloudErrorBody

Body of an error from a REST request.

AttachDiskProperties

Properties of the disk to attach.

Name Type Description
leasedByLabVmId

string

The resource ID of the Lab virtual machine to which the disk is attached.

CloudError

Error from a REST request.

Name Type Description
error

CloudErrorBody

The cloud error that occurred

CloudErrorBody

Body of an error from a REST request.

Name Type Description
code

string

The error code.

details

CloudErrorBody[]

Inner errors.

message

string

The error message.

target

string

The error target.