Virtual Machines - Add Data Disk

Service:

Dev Test Labs

API Version:

2018-09-15

Attach a new or existing data disk to virtual machine. This operation can take a while to complete.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/addDataDisk?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 virtual machine.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	The subscription ID.
api-version	query	True	string	Client API version.

Request Body

Name	Type	Description
attachNewDataDiskOptions	AttachNewDataDiskOptions	Specifies options to attach a new disk to the virtual machine.
existingLabDiskId	string	Specifies the existing lab disk id to attach to virtual machine.
hostCaching	HostCachingOptions	Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).

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

VirtualMachines_AddDataDisk

Sample Request

HTTP

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/addDataDisk?api-version=2018-09-15

{
  "attachNewDataDiskOptions": {
    "diskSizeGiB": 127,
    "diskName": "{diskName}",
    "diskType": "{diskType}"
  }
}

Java

import com.azure.resourcemanager.devtestlabs.models.AttachNewDataDiskOptions;
import com.azure.resourcemanager.devtestlabs.models.DataDiskProperties;
import com.azure.resourcemanager.devtestlabs.models.StorageType;

/** Samples for VirtualMachines AddDataDisk. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_AddDataDisk.json
     */
    /**
     * Sample code: VirtualMachines_AddDataDisk.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void virtualMachinesAddDataDisk(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager
            .virtualMachines()
            .addDataDisk(
                "resourceGroupName",
                "{labName}",
                "{virtualMachineName}",
                new DataDiskProperties()
                    .withAttachNewDataDiskOptions(
                        new AttachNewDataDiskOptions()
                            .withDiskSizeGiB(127)
                            .withDiskName("{diskName}")
                            .withDiskType(StorageType.fromString("{diskType}"))),
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.devtestlabs import DevTestLabsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devtestlabs
# USAGE
    python virtual_machines_add_data_disk.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DevTestLabsClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscriptionId}",
    )

    response = client.virtual_machines.begin_add_data_disk(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
        name="{virtualMachineName}",
        data_disk_properties={
            "attachNewDataDiskOptions": {"diskName": "{diskName}", "diskSizeGiB": 127, "diskType": "{diskType}"}
        },
    ).result()
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_AddDataDisk.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdevtestlabs_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/devtestlabs/armdevtestlabs"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_AddDataDisk.json
func ExampleVirtualMachinesClient_BeginAddDataDisk() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdevtestlabs.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVirtualMachinesClient().BeginAddDataDisk(ctx, "resourceGroupName", "{labName}", "{virtualMachineName}", armdevtestlabs.DataDiskProperties{
		AttachNewDataDiskOptions: &armdevtestlabs.AttachNewDataDiskOptions{
			DiskName:    to.Ptr("{diskName}"),
			DiskSizeGiB: to.Ptr[int32](127),
			DiskType:    to.Ptr(armdevtestlabs.StorageType("{diskType}")),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DevTestLabsClient } = require("@azure/arm-devtestlabs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Attach a new or existing data disk to virtual machine. This operation can take a while to complete.
 *
 * @summary Attach a new or existing data disk to virtual machine. This operation can take a while to complete.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_AddDataDisk.json
 */
async function virtualMachinesAddDataDisk() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const name = "{virtualMachineName}";
  const dataDiskProperties = {
    attachNewDataDiskOptions: {
      diskName: "{diskName}",
      diskSizeGiB: 127,
      diskType: "{diskType}",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.virtualMachines.beginAddDataDiskAndWait(
    resourceGroupName,
    labName,
    name,
    dataDiskProperties
  );
  console.log(result);
}

virtualMachinesAddDataDisk().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DevTestLabs;
using Azure.ResourceManager.DevTestLabs.Models;

// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_AddDataDisk.json
// this example is just showing the usage of "VirtualMachines_AddDataDisk" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DevTestLabVmResource created on azure
// for more information of creating DevTestLabVmResource, please refer to the document of DevTestLabVmResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "resourceGroupName";
string labName = "{labName}";
string name = "{virtualMachineName}";
ResourceIdentifier devTestLabVmResourceId = DevTestLabVmResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, labName, name);
DevTestLabVmResource devTestLabVm = client.GetDevTestLabVmResource(devTestLabVmResourceId);

// invoke the operation
DevTestLabDataDiskProperties dataDiskProperties = new DevTestLabDataDiskProperties()
{
    AttachNewDataDiskOptions = new AttachNewDataDiskDetails()
    {
        DiskSizeGiB = 127,
        DiskName = "{diskName}",
        DiskType = new DevTestLabStorageType("{diskType}"),
    },
};
await devTestLabVm.AddDataDiskAsync(WaitUntil.Completed, dataDiskProperties);

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

Status code:

202

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

Definitions

Name	Description
AttachNewDataDiskOptions	Properties to attach new disk to the Virtual Machine.
CloudError	Error from a REST request.
CloudErrorBody	Body of an error from a REST request.
DataDiskProperties	Request body for adding a new or existing data disk to a virtual machine.
HostCachingOptions	Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).
StorageType	The storage type for the disk (i.e. Standard, Premium).

AttachNewDataDiskOptions

Properties to attach new disk to the Virtual Machine.

Name	Type	Description
diskName	string	The name of the disk to be attached.
diskSizeGiB	integer	Size of the disk to be attached in Gibibytes.
diskType	StorageType	The storage type for the disk (i.e. Standard, Premium).

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.

DataDiskProperties

Request body for adding a new or existing data disk to a virtual machine.

Name	Type	Description
attachNewDataDiskOptions	AttachNewDataDiskOptions	Specifies options to attach a new disk to the virtual machine.
existingLabDiskId	string	Specifies the existing lab disk id to attach to virtual machine.
hostCaching	HostCachingOptions	Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).

HostCachingOptions

Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).

Name	Type	Description
None	string
ReadOnly	string
ReadWrite	string

StorageType

The storage type for the disk (i.e. Standard, Premium).

Name	Type	Description
Premium	string
Standard	string
StandardSSD	string