Virtual Machines - Attach Detach Data Disks

Servicio:

Compute

Versión de la API:

2024-07-01

Conecte y desasocie discos de datos hacia o desde la máquina virtual.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/attachDetachDataDisks?api-version=2024-07-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
vmName	path	True	string	Nombre de la máquina virtual.
api-version	query	True	string	Versión de api de cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
parameters	AttachDetachDataDisksRequest	Parámetros proporcionados para la operación de conexión y desasociación de discos de datos en la máquina virtual.

Respuestas

Nombre	Tipo	Description
200 OK	StorageProfile	De acuerdo
202 Accepted		Aceptado Encabezados Location: string
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

Solicitud de ejemplo

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/aaaaaaaaaaaaaaaaaaaa/attachDetachDataDisks?api-version=2024-07-01

{
  "dataDisksToAttach": [
    {
      "lun": 1,
      "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
      "diskEncryptionSet": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
      },
      "caching": "ReadOnly",
      "deleteOption": "Delete",
      "writeAcceleratorEnabled": true
    },
    {
      "lun": 2,
      "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e",
      "diskEncryptionSet": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
      },
      "caching": "ReadWrite",
      "deleteOption": "Detach",
      "writeAcceleratorEnabled": false
    }
  ],
  "dataDisksToDetach": [
    {
      "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x",
      "detachOption": "ForceDetach"
    },
    {
      "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_4_disk4_4d4e784bdafa49baa780eb2d256ff41z",
      "detachOption": "ForceDetach"
    }
  ]
}

Java

import com.azure.resourcemanager.compute.models.AttachDetachDataDisksRequest;
import com.azure.resourcemanager.compute.models.CachingTypes;
import com.azure.resourcemanager.compute.models.DataDisksToAttach;
import com.azure.resourcemanager.compute.models.DataDisksToDetach;
import com.azure.resourcemanager.compute.models.DiskDeleteOptionTypes;
import com.azure.resourcemanager.compute.models.DiskDetachOptionTypes;
import com.azure.resourcemanager.compute.models.DiskEncryptionSetParameters;
import java.util.Arrays;

/**
 * Samples for VirtualMachines AttachDetachDataDisks.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        virtualMachineAttachDetachDataDisksMaximumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines().attachDetachDataDisks("rgcompute",
            "aaaaaaaaaaaaaaaaaaaa",
            new AttachDetachDataDisksRequest().withDataDisksToAttach(Arrays.asList(new DataDisksToAttach().withDiskId(
                "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d")
                .withLun(1).withCaching(CachingTypes.READ_ONLY).withDeleteOption(DiskDeleteOptionTypes.DELETE)
                .withDiskEncryptionSet(new DiskEncryptionSetParameters().withId(
                    "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"))
                .withWriteAcceleratorEnabled(true),
                new DataDisksToAttach().withDiskId(
                    "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e")
                    .withLun(2).withCaching(CachingTypes.READ_WRITE).withDeleteOption(DiskDeleteOptionTypes.DETACH)
                    .withDiskEncryptionSet(new DiskEncryptionSetParameters().withId(
                        "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"))
                    .withWriteAcceleratorEnabled(false)))
                .withDataDisksToDetach(Arrays.asList(new DataDisksToDetach().withDiskId(
                    "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x")
                    .withDetachOption(DiskDetachOptionTypes.FORCE_DETACH),
                    new DataDisksToDetach().withDiskId(
                        "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_4_disk4_4d4e784bdafa49baa780eb2d256ff41z")
                        .withDetachOption(DiskDetachOptionTypes.FORCE_DETACH))),
            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.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_attach_detach_data_disks_maximum_set_gen.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 = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.virtual_machines.begin_attach_detach_data_disks(
        resource_group_name="rgcompute",
        vm_name="aaaaaaaaaaaaaaaaaaaa",
        parameters={
            "dataDisksToAttach": [
                {
                    "caching": "ReadOnly",
                    "deleteOption": "Delete",
                    "diskEncryptionSet": {
                        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
                    },
                    "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
                    "lun": 1,
                    "writeAcceleratorEnabled": True,
                },
                {
                    "caching": "ReadWrite",
                    "deleteOption": "Detach",
                    "diskEncryptionSet": {
                        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
                    },
                    "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e",
                    "lun": 2,
                    "writeAcceleratorEnabled": False,
                },
            ],
            "dataDisksToDetach": [
                {
                    "detachOption": "ForceDetach",
                    "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x",
                },
                {
                    "detachOption": "ForceDetach",
                    "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_4_disk4_4d4e784bdafa49baa780eb2d256ff41z",
                },
            ],
        },
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.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 armcompute_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/compute/armcompute/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.json
func ExampleVirtualMachinesClient_BeginAttachDetachDataDisks_virtualMachineAttachDetachDataDisksMaximumSetGen() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVirtualMachinesClient().BeginAttachDetachDataDisks(ctx, "rgcompute", "aaaaaaaaaaaaaaaaaaaa", armcompute.AttachDetachDataDisksRequest{
		DataDisksToAttach: []*armcompute.DataDisksToAttach{
			{
				Caching:      to.Ptr(armcompute.CachingTypesReadOnly),
				DeleteOption: to.Ptr(armcompute.DiskDeleteOptionTypesDelete),
				DiskEncryptionSet: &armcompute.DiskEncryptionSetParameters{
					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"),
				},
				DiskID:                  to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
				Lun:                     to.Ptr[int32](1),
				WriteAcceleratorEnabled: to.Ptr(true),
			},
			{
				Caching:      to.Ptr(armcompute.CachingTypesReadWrite),
				DeleteOption: to.Ptr(armcompute.DiskDeleteOptionTypesDetach),
				DiskEncryptionSet: &armcompute.DiskEncryptionSetParameters{
					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"),
				},
				DiskID:                  to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e"),
				Lun:                     to.Ptr[int32](2),
				WriteAcceleratorEnabled: to.Ptr(false),
			}},
		DataDisksToDetach: []*armcompute.DataDisksToDetach{
			{
				DetachOption: to.Ptr(armcompute.DiskDetachOptionTypesForceDetach),
				DiskID:       to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x"),
			},
			{
				DetachOption: to.Ptr(armcompute.DiskDetachOptionTypesForceDetach),
				DiskID:       to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_4_disk4_4d4e784bdafa49baa780eb2d256ff41z"),
			}},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.StorageProfile = armcompute.StorageProfile{
	// 	DataDisks: []*armcompute.DataDisk{
	// 		{
	// 			Name: to.Ptr("vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 			Caching: to.Ptr(armcompute.CachingTypesReadOnly),
	// 			CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesAttach),
	// 			DeleteOption: to.Ptr(armcompute.DiskDeleteOptionTypesDelete),
	// 			DiskSizeGB: to.Ptr[int32](30),
	// 			Lun: to.Ptr[int32](1),
	// 			ManagedDisk: &armcompute.ManagedDiskParameters{
	// 				ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 				DiskEncryptionSet: &armcompute.DiskEncryptionSetParameters{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"),
	// 				},
	// 				StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 			},
	// 			WriteAcceleratorEnabled: to.Ptr(true),
	// 		},
	// 		{
	// 			Name: to.Ptr("vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e"),
	// 			Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 			CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesAttach),
	// 			DeleteOption: to.Ptr(armcompute.DiskDeleteOptionTypesDetach),
	// 			DiskSizeGB: to.Ptr[int32](100),
	// 			Lun: to.Ptr[int32](2),
	// 			ManagedDisk: &armcompute.ManagedDiskParameters{
	// 				ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e"),
	// 				DiskEncryptionSet: &armcompute.DiskEncryptionSetParameters{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"),
	// 				},
	// 				StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 			},
	// 			WriteAcceleratorEnabled: to.Ptr(false),
	// 	}},
	// 	ImageReference: &armcompute.ImageReference{
	// 		Offer: to.Ptr("WindowsServer"),
	// 		Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 		SKU: to.Ptr("2016-Datacenter"),
	// 		Version: to.Ptr("latest"),
	// 	},
	// 	OSDisk: &armcompute.OSDisk{
	// 		Name: to.Ptr("myOsDisk"),
	// 		Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 		CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 		DiskSizeGB: to.Ptr[int32](30),
	// 		ManagedDisk: &armcompute.ManagedDiskParameters{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"),
	// 			StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 		},
	// 		OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 	},
	// }
}

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 { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Attach and detach data disks to/from the virtual machine.
 *
 * @summary Attach and detach data disks to/from the virtual machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.json
 */
async function virtualMachineAttachDetachDataDisksMaximumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const vmName = "aaaaaaaaaaaaaaaaaaaa";
  const parameters = {
    dataDisksToAttach: [
      {
        caching: "ReadOnly",
        deleteOption: "Delete",
        diskEncryptionSet: {
          id: "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}",
        },
        diskId:
          "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
        lun: 1,
        writeAcceleratorEnabled: true,
      },
      {
        caching: "ReadWrite",
        deleteOption: "Detach",
        diskEncryptionSet: {
          id: "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}",
        },
        diskId:
          "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e",
        lun: 2,
        writeAcceleratorEnabled: false,
      },
    ],
    dataDisksToDetach: [
      {
        detachOption: "ForceDetach",
        diskId:
          "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x",
      },
      {
        detachOption: "ForceDetach",
        diskId:
          "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_4_disk4_4d4e784bdafa49baa780eb2d256ff41z",
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.beginAttachDetachDataDisksAndWait(
    resourceGroupName,
    vmName,
    parameters,
  );
  console.log(result);
}

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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.json
// this example is just showing the usage of "VirtualMachines_AttachDetachDataDisks" 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 VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "rgcompute";
string vmName = "aaaaaaaaaaaaaaaaaaaa";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

// invoke the operation
AttachDetachDataDisksRequest attachDetachDataDisksRequest = new AttachDetachDataDisksRequest
{
    DataDisksToAttach = {new DataDisksToAttach("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d")
    {
    Lun = 1,
    Caching = CachingType.ReadOnly,
    DeleteOption = DiskDeleteOptionType.Delete,
    DiskEncryptionSetId = new ResourceIdentifier("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"),
    WriteAcceleratorEnabled = true,
    }, new DataDisksToAttach("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e")
    {
    Lun = 2,
    Caching = CachingType.ReadWrite,
    DeleteOption = DiskDeleteOptionType.Detach,
    DiskEncryptionSetId = new ResourceIdentifier("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"),
    WriteAcceleratorEnabled = false,
    }},
    DataDisksToDetach = {new DataDisksToDetach("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x")
    {
    DetachOption = DiskDetachOptionType.ForceDetach,
    }, new DataDisksToDetach("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_4_disk4_4d4e784bdafa49baa780eb2d256ff41z")
    {
    DetachOption = DiskDetachOptionType.ForceDetach,
    }},
};
ArmOperation<VirtualMachineStorageProfile> lro = await virtualMachine.AttachDetachDataDisksAsync(WaitUntil.Completed, attachDetachDataDisksRequest);
VirtualMachineStorageProfile result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

Respuesta de muestra

status code:

200

location: https://foo.com/operationstatus

{
  "imageReference": {
    "publisher": "MicrosoftWindowsServer",
    "offer": "WindowsServer",
    "sku": "2016-Datacenter",
    "version": "latest"
  },
  "osDisk": {
    "osType": "Windows",
    "name": "myOsDisk",
    "createOption": "FromImage",
    "caching": "ReadWrite",
    "managedDisk": {
      "storageAccountType": "Premium_LRS",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
    },
    "diskSizeGB": 30
  },
  "dataDisks": [
    {
      "lun": 1,
      "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
      "createOption": "Attach",
      "caching": "ReadOnly",
      "managedDisk": {
        "storageAccountType": "Premium_LRS",
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
        "diskEncryptionSet": {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
        }
      },
      "deleteOption": "Delete",
      "diskSizeGB": 30,
      "writeAcceleratorEnabled": true
    },
    {
      "lun": 2,
      "name": "vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e",
      "createOption": "Attach",
      "caching": "ReadWrite",
      "managedDisk": {
        "storageAccountType": "Premium_LRS",
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e",
        "diskEncryptionSet": {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
        }
      },
      "deleteOption": "Detach",
      "diskSizeGB": 100,
      "writeAcceleratorEnabled": false
    }
  ]
}

status code:

202

location: https://foo.com/operationstatus

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

Solicitud de ejemplo

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/azure-vm/attachDetachDataDisks?api-version=2024-07-01

{
  "dataDisksToAttach": [
    {
      "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"
    }
  ],
  "dataDisksToDetach": [
    {
      "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x"
    }
  ]
}

Java

import com.azure.resourcemanager.compute.models.AttachDetachDataDisksRequest;
import com.azure.resourcemanager.compute.models.DataDisksToAttach;
import com.azure.resourcemanager.compute.models.DataDisksToDetach;
import java.util.Arrays;

/**
 * Samples for VirtualMachines AttachDetachDataDisks.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        virtualMachineAttachDetachDataDisksMinimumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines().attachDetachDataDisks("rgcompute",
            "azure-vm",
            new AttachDetachDataDisksRequest().withDataDisksToAttach(Arrays.asList(new DataDisksToAttach().withDiskId(
                "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d")))
                .withDataDisksToDetach(Arrays.asList(new DataDisksToDetach().withDiskId(
                    "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x"))),
            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.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_attach_detach_data_disks_minimum_set_gen.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 = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.virtual_machines.begin_attach_detach_data_disks(
        resource_group_name="rgcompute",
        vm_name="azure-vm",
        parameters={
            "dataDisksToAttach": [
                {
                    "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"
                }
            ],
            "dataDisksToDetach": [
                {
                    "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x"
                }
            ],
        },
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.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 armcompute_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/compute/armcompute/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.json
func ExampleVirtualMachinesClient_BeginAttachDetachDataDisks_virtualMachineAttachDetachDataDisksMinimumSetGen() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVirtualMachinesClient().BeginAttachDetachDataDisks(ctx, "rgcompute", "azure-vm", armcompute.AttachDetachDataDisksRequest{
		DataDisksToAttach: []*armcompute.DataDisksToAttach{
			{
				DiskID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
			}},
		DataDisksToDetach: []*armcompute.DataDisksToDetach{
			{
				DiskID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x"),
			}},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.StorageProfile = armcompute.StorageProfile{
	// 	DataDisks: []*armcompute.DataDisk{
	// 		{
	// 			Name: to.Ptr("vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 			Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 			CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesAttach),
	// 			DiskSizeGB: to.Ptr[int32](30),
	// 			Lun: to.Ptr[int32](0),
	// 			ManagedDisk: &armcompute.ManagedDiskParameters{
	// 				ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 				StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 			},
	// 	}},
	// 	ImageReference: &armcompute.ImageReference{
	// 		Offer: to.Ptr("WindowsServer"),
	// 		Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 		SKU: to.Ptr("2016-Datacenter"),
	// 		Version: to.Ptr("latest"),
	// 	},
	// 	OSDisk: &armcompute.OSDisk{
	// 		Name: to.Ptr("myOsDisk"),
	// 		Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 		CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 		DiskSizeGB: to.Ptr[int32](30),
	// 		ManagedDisk: &armcompute.ManagedDiskParameters{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"),
	// 			StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 		},
	// 		OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 	},
	// }
}

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 { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Attach and detach data disks to/from the virtual machine.
 *
 * @summary Attach and detach data disks to/from the virtual machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.json
 */
async function virtualMachineAttachDetachDataDisksMinimumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const vmName = "azure-vm";
  const parameters = {
    dataDisksToAttach: [
      {
        diskId:
          "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
      },
    ],
    dataDisksToDetach: [
      {
        diskId:
          "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x",
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.beginAttachDetachDataDisksAndWait(
    resourceGroupName,
    vmName,
    parameters,
  );
  console.log(result);
}

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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.json
// this example is just showing the usage of "VirtualMachines_AttachDetachDataDisks" 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 VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "rgcompute";
string vmName = "azure-vm";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

// invoke the operation
AttachDetachDataDisksRequest attachDetachDataDisksRequest = new AttachDetachDataDisksRequest
{
    DataDisksToAttach = { new DataDisksToAttach("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d") },
    DataDisksToDetach = { new DataDisksToDetach("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x") },
};
ArmOperation<VirtualMachineStorageProfile> lro = await virtualMachine.AttachDetachDataDisksAsync(WaitUntil.Completed, attachDetachDataDisksRequest);
VirtualMachineStorageProfile result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

Respuesta de muestra

status code:

200

location: https://foo.com/operationstatus

{
  "imageReference": {
    "publisher": "MicrosoftWindowsServer",
    "offer": "WindowsServer",
    "sku": "2016-Datacenter",
    "version": "latest"
  },
  "osDisk": {
    "osType": "Windows",
    "name": "myOsDisk",
    "createOption": "FromImage",
    "caching": "ReadWrite",
    "managedDisk": {
      "storageAccountType": "Premium_LRS",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
    },
    "diskSizeGB": 30
  },
  "dataDisks": [
    {
      "lun": 0,
      "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
      "createOption": "Attach",
      "caching": "ReadWrite",
      "managedDisk": {
        "storageAccountType": "Premium_LRS",
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"
      },
      "diskSizeGB": 30
    }
  ]
}

status code:

202

location: https://foo.com/operationstatus

Definiciones

Nombre	Description
ApiEntityReference	Identificador del recurso de origen. Puede ser una instantánea o un punto de restauración de disco desde el que crear un disco.
ApiError	Error de API.
ApiErrorBase	Base de errores de api.
AttachDetachDataDisksRequest	Parámetros proporcionados para la operación de conexión y desasociación de discos de datos en la máquina virtual.
CachingTypes	Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None,ReadOnly,ReadWrite. El comportamiento predeterminado es: Ninguno para el almacenamiento estándar. ReadOnly para Premium Storage.
CloudError	Respuesta de error del servicio Compute.
DataDisk	Especifica los parámetros que se usan para agregar un disco de datos a una máquina virtual. Para más información sobre los discos, consulte Acerca de discos y discos duros virtuales para máquinas virtuales de Azure.
DataDisksToAttach	Lista de discos de datos administrados que se van a conectar.
DataDisksToDetach	Lista de discos de datos administrados que se van a desasociar.
DiffDiskOptions	Especifica la configuración del disco efímero para el disco del sistema operativo.
DiffDiskPlacement	Especifica la ubicación del disco efímero para el disco del sistema operativo. Los valores posibles son: CacheDisk,ResourceDisk,NvmeDisk. El comportamiento predeterminado es: CacheDisk si se configura uno para el tamaño de la máquina virtual en caso contrario, se usa resourceDisk o nvmeDisk. Consulte la documentación sobre el tamaño de la máquina virtual Windows en https://docs.microsoft.com/azure/virtual-machines/windows/sizes y máquina virtual Linux en https://docs.microsoft.com/azure/virtual-machines/linux/sizes para comprobar qué tamaños de máquina virtual expone un disco de caché. Versión mínima de api para NvmeDisk: 2024-03-01.
DiffDiskSettings	Especifica la configuración de disco efímero para el disco del sistema operativo utilizado por la máquina virtual.
DiskControllerTypes	Especifica el tipo de controlador de disco configurado para la máquina virtual. Nota: Esta propiedad se establecerá en el tipo de controlador de disco predeterminado si no se especifica que se cree una máquina virtual con "hyperVGeneration" establecido en V2 en función de las funcionalidades del disco del sistema operativo y el tamaño de máquina virtual de la versión mínima de api especificada. Debe desasignar la máquina virtual antes de actualizar su tipo de controlador de disco a menos que actualice el tamaño de la máquina virtual en la configuración de la máquina virtual que desasigna implícitamente y reasigna la máquina virtual. Versión mínima de api: 2022-08-01.
DiskCreateOptionTypes	Especifica cómo se debe crear el disco de máquina virtual. Los valores posibles son Adjuntar: Este valor se usa cuando se usa un disco especializado para crear la máquina virtual. FromImage: Este valor se usa cuando se usa una imagen para crear la máquina virtual. Si usa una imagen de plataforma, también debe usar el elemento imageReference descrito anteriormente. Si usa una imagen de Marketplace, también debe usar el elemento plan descrito anteriormente.
DiskDeleteOptionTypes	Especifica si el disco del sistema operativo se debe eliminar o desasociar tras la eliminación de la máquina virtual. Los valores posibles son: Delete. Si se usa este valor, el disco del sistema operativo se elimina cuando se elimina la máquina virtual. Separar. Si se usa este valor, el disco del sistema operativo se conserva después de eliminar la máquina virtual. El valor predeterminado se establece en Desasociar. Para un disco de sistema operativo efímero, el valor predeterminado se establece en Eliminar. El usuario no puede cambiar la opción de eliminación de un disco de sistema operativo efímero.
DiskDetachOptionTypes	Especifica el comportamiento de desasociación que se va a usar al desasociar un disco o que ya está en proceso de desasociación de la máquina virtual. Valores admitidos: ForceDetach. detachOption: ForceDetach solo se aplica a discos de datos administrados. Si un intento anterior de desasociación del disco de datos no se completó debido a un error inesperado de la máquina virtual y el disco todavía no se libera, use la opción forzar la desasociación como última opción de recurso para separar el disco forzadamente de la máquina virtual. Es posible que todas las escrituras no se hayan vaciado al usar este comportamiento de desasociación. Para forzar la desasociación de una actualización del disco de datos aBeDetached a "true" junto con la configuración de detachOption: "ForceDetach".
DiskEncryptionSetParameters	Especifica el identificador de recurso del conjunto de cifrado de disco administrado del cliente para el disco administrado.
DiskEncryptionSettings	Especifica la configuración de cifrado del disco del sistema operativo. Versión mínima de api: 2015-06-15.
ImageReference	Especifica información sobre la imagen que se va a usar. Puede especificar información sobre imágenes de plataforma, imágenes de Marketplace o imágenes de máquina virtual. Este elemento es necesario cuando desea usar una imagen de plataforma, una imagen de Marketplace o una imagen de máquina virtual, pero no se usa en otras operaciones de creación.
InnerError	Detalles del error interno.
KeyVaultKeyReference	Especifica la ubicación de la clave de cifrado de claves en Key Vault.
KeyVaultSecretReference	Especifica la ubicación de la clave de cifrado de disco, que es un secreto de Key Vault.
ManagedDiskParameters	Parámetros de disco administrado.
OperatingSystemTypes	Tipo de sistema operativo.
OSDisk	Especifica información sobre el disco del sistema operativo utilizado por la máquina virtual. Para más información sobre los discos, consulte Acerca de discos y discos duros virtuales para máquinas virtuales de Azure.
securityEncryptionTypes	Especifica encryptionType del disco administrado. Se establece en DiskWithVMGuestState para el cifrado del disco administrado junto con el blob VMGuestState, VMGuestStateOnly para el cifrado de solo el blob VMGuestState y NonPersistedTPM para no conservar el estado de firmware en el blob VMGuestState. Nota: Solo se puede establecer para máquinas virtuales confidenciales.
StorageAccountTypes	Especifica el tipo de cuenta de almacenamiento para el disco administrado. NOTA: UltraSSD_LRS solo se puede usar con discos de datos, no se puede usar con disco del sistema operativo.
StorageProfile	Especifica la configuración de almacenamiento de los discos de máquina virtual.
SubResource
VirtualHardDisk	Disco duro virtual.
VMDiskSecurityProfile	Especifica el perfil de seguridad del disco administrado.

ApiEntityReference

Identificador del recurso de origen. Puede ser una instantánea o un punto de restauración de disco desde el que crear un disco.

Nombre	Tipo	Description
id	string	Identificador de recurso de ARM en forma de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Error de API.

Nombre	Tipo	Description
code	string	Código de error.
details	ApiErrorBase[]	Detalles del error de api
innererror	InnerError	Error interno de api
message	string	Mensaje de error.
target	string	Destino del error concreto.

ApiErrorBase

Base de errores de api.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error.
target	string	Destino del error concreto.

AttachDetachDataDisksRequest

Parámetros proporcionados para la operación de conexión y desasociación de discos de datos en la máquina virtual.

Nombre	Tipo	Description
dataDisksToAttach	DataDisksToAttach[]	Lista de discos de datos administrados que se van a conectar.
dataDisksToDetach	DataDisksToDetach[]	Lista de discos de datos administrados que se van a desasociar.

CachingTypes

Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None,ReadOnly,ReadWrite. El comportamiento predeterminado es: Ninguno para el almacenamiento estándar. ReadOnly para Premium Storage.

Nombre	Tipo	Description
None	string
ReadOnly	string
ReadWrite	string

CloudError

Respuesta de error del servicio Compute.

Nombre	Tipo	Description
error	ApiError	Error de API.

DataDisk

Especifica los parámetros que se usan para agregar un disco de datos a una máquina virtual. Para más información sobre los discos, consulte Acerca de discos y discos duros virtuales para máquinas virtuales de Azure.

Nombre	Tipo	Description
caching	CachingTypes	Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None,ReadOnly,ReadWrite. El comportamiento predeterminado es: Ninguno para el almacenamiento estándar. ReadOnly para Premium Storage.
createOption	DiskCreateOptionTypes	Especifica cómo se debe crear el disco de máquina virtual. Los valores posibles son Adjuntar: Este valor se usa cuando se usa un disco especializado para crear la máquina virtual. FromImage: Este valor se usa cuando se usa una imagen para crear el disco de datos de la máquina virtual. Si usa una imagen de plataforma, también debe usar el elemento imageReference descrito anteriormente. Si usa una imagen de Marketplace, también debe usar el elemento plan descrito anteriormente. Vacío: Este valor se usa al crear un disco de datos vacío. Copiar: Este valor se usa para crear un disco de datos a partir de una instantánea u otro disco. Restaurar: Este valor se usa para crear un disco de datos a partir de un punto de restauración de disco.
deleteOption	DiskDeleteOptionTypes	Especifica si se debe eliminar o desasociar el disco de datos tras la eliminación de la máquina virtual. Los valores posibles son: Delete. Si se usa este valor, el disco de datos se elimina cuando se elimina la máquina virtual. Separar. Si se usa este valor, el disco de datos se conserva después de eliminar la máquina virtual. El valor predeterminado se establece en Desasociar.
detachOption	DiskDetachOptionTypes	Especifica el comportamiento de desasociación que se va a usar al desasociar un disco o que ya está en proceso de desasociación de la máquina virtual. Valores admitidos: ForceDetach. detachOption: ForceDetach solo se aplica a discos de datos administrados. Si un intento anterior de desasociación del disco de datos no se completó debido a un error inesperado de la máquina virtual y el disco todavía no se libera, use la opción forzar la desasociación como última opción de recurso para separar el disco forzadamente de la máquina virtual. Es posible que todas las escrituras no se hayan vaciado al usar este comportamiento de desasociación. Para forzar la desasociación de una actualización del disco de datos aBeDetached a "true" junto con la configuración de detachOption: "ForceDetach".
diskIOPSReadWrite	integer	Especifica el Read-Write IOPS del disco administrado cuando se UltraSSD_LRS StorageAccountType. Se devuelve solo para los discos de máquina virtual VirtualMachine ScaleSet. Solo se puede actualizar a través de las actualizaciones del conjunto de escalado virtualMachine.
diskMBpsReadWrite	integer	Especifica el ancho de banda en MB por segundo para el disco administrado cuando StorageAccountType es UltraSSD_LRS. Se devuelve solo para los discos de máquina virtual VirtualMachine ScaleSet. Solo se puede actualizar a través de las actualizaciones del conjunto de escalado virtualMachine.
diskSizeGB	integer	Especifica el tamaño de un disco de datos vacío en gigabytes. Este elemento se puede usar para sobrescribir el tamaño del disco en una imagen de máquina virtual. La propiedad 'diskSizeGB' es el número de bytes x 1024^3 para el disco y el valor no puede ser mayor que 1023.
image	VirtualHardDisk	Disco duro virtual de la imagen de usuario de origen. El disco duro virtual se copiará antes de conectarse a la máquina virtual. Si se proporciona SourceImage, el disco duro virtual de destino no debe existir.
lun	integer	Especifica el número de unidad lógica del disco de datos. Este valor se usa para identificar discos de datos dentro de la máquina virtual y, por tanto, debe ser único para cada disco de datos conectado a una máquina virtual.
managedDisk	ManagedDiskParameters	Parámetros de disco administrado.
name	string	Nombre del disco.
sourceResource	ApiEntityReference	Identificador del recurso de origen. Puede ser una instantánea o un punto de restauración de disco desde el que crear un disco.
toBeDetached	boolean	Especifica si el disco de datos está en proceso de desasociamiento de VirtualMachine/VirtualMachineScaleset
vhd	VirtualHardDisk	Disco duro virtual.
writeAcceleratorEnabled	boolean	Especifica si writeAccelerator debe estar habilitado o deshabilitado en el disco.

DataDisksToAttach

Lista de discos de datos administrados que se van a conectar.

Nombre	Tipo	Description
caching	CachingTypes	Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None,ReadOnly,ReadWrite. El comportamiento predeterminado es: Ninguno para el almacenamiento estándar. ReadOnly para Premium Storage.
deleteOption	DiskDeleteOptionTypes	Especifica si se debe eliminar o desasociar el disco de datos tras la eliminación de la máquina virtual. Los valores posibles son: Delete. Si se usa este valor, el disco de datos se elimina cuando se elimina la máquina virtual. Separar. Si se usa este valor, el disco de datos se conserva después de eliminar la máquina virtual. El valor predeterminado se establece en Desasociar.
diskEncryptionSet	DiskEncryptionSetParameters	Especifica el identificador de recurso del conjunto de cifrado de disco administrado del cliente para el disco administrado.
diskId	string	Identificador del disco de datos administrado.
lun	integer	Número de unidad lógica del disco de datos. Este valor se usa para identificar discos de datos dentro de la máquina virtual y, por tanto, debe ser único para cada disco de datos conectado a una máquina virtual. Si no se especifica, se asignaría automáticamente lun.
writeAcceleratorEnabled	boolean	Especifica si writeAccelerator debe estar habilitado o deshabilitado en el disco.

DataDisksToDetach

Lista de discos de datos administrados que se van a desasociar.

Nombre	Tipo	Description
detachOption	DiskDetachOptionTypes	Opciones admitidas disponibles para desasociar un disco de una máquina virtual. Consulte La referencia de objetos DetachOption para obtener más detalles.
diskId	string	Identificador del disco de datos administrado.

DiffDiskOptions

Especifica la configuración del disco efímero para el disco del sistema operativo.

Nombre	Tipo	Description
Local	string

DiffDiskPlacement

Especifica la ubicación del disco efímero para el disco del sistema operativo. Los valores posibles son: CacheDisk,ResourceDisk,NvmeDisk. El comportamiento predeterminado es: CacheDisk si se configura uno para el tamaño de la máquina virtual en caso contrario, se usa resourceDisk o nvmeDisk. Consulte la documentación sobre el tamaño de la máquina virtual Windows en https://docs.microsoft.com/azure/virtual-machines/windows/sizes y máquina virtual Linux en https://docs.microsoft.com/azure/virtual-machines/linux/sizes para comprobar qué tamaños de máquina virtual expone un disco de caché. Versión mínima de api para NvmeDisk: 2024-03-01.

Nombre	Tipo	Description
CacheDisk	string
NvmeDisk	string
ResourceDisk	string

DiffDiskSettings

Especifica la configuración de disco efímero para el disco del sistema operativo utilizado por la máquina virtual.

Nombre	Tipo	Description
option	DiffDiskOptions	Especifica la configuración del disco efímero para el disco del sistema operativo.
placement	DiffDiskPlacement	Especifica la ubicación del disco efímero para el disco del sistema operativo. Los valores posibles son: CacheDisk,ResourceDisk,NvmeDisk. El comportamiento predeterminado es: CacheDisk si se configura uno para el tamaño de la máquina virtual en caso contrario, se usa resourceDisk o nvmeDisk. Consulte la documentación sobre el tamaño de la máquina virtual Windows en https://docs.microsoft.com/azure/virtual-machines/windows/sizes y máquina virtual Linux en https://docs.microsoft.com/azure/virtual-machines/linux/sizes para comprobar qué tamaños de máquina virtual expone un disco de caché. Versión mínima de api para NvmeDisk: 2024-03-01.

DiskControllerTypes

Especifica el tipo de controlador de disco configurado para la máquina virtual. Nota: Esta propiedad se establecerá en el tipo de controlador de disco predeterminado si no se especifica que se cree una máquina virtual con "hyperVGeneration" establecido en V2 en función de las funcionalidades del disco del sistema operativo y el tamaño de máquina virtual de la versión mínima de api especificada. Debe desasignar la máquina virtual antes de actualizar su tipo de controlador de disco a menos que actualice el tamaño de la máquina virtual en la configuración de la máquina virtual que desasigna implícitamente y reasigna la máquina virtual. Versión mínima de api: 2022-08-01.

Nombre	Tipo	Description
NVMe	string
SCSI	string

DiskCreateOptionTypes

Especifica cómo se debe crear el disco de máquina virtual. Los valores posibles son Adjuntar: Este valor se usa cuando se usa un disco especializado para crear la máquina virtual. FromImage: Este valor se usa cuando se usa una imagen para crear la máquina virtual. Si usa una imagen de plataforma, también debe usar el elemento imageReference descrito anteriormente. Si usa una imagen de Marketplace, también debe usar el elemento plan descrito anteriormente.

Nombre	Tipo	Description
Attach	string
Copy	string
Empty	string
FromImage	string
Restore	string

DiskDeleteOptionTypes

Especifica si el disco del sistema operativo se debe eliminar o desasociar tras la eliminación de la máquina virtual. Los valores posibles son: Delete. Si se usa este valor, el disco del sistema operativo se elimina cuando se elimina la máquina virtual. Separar. Si se usa este valor, el disco del sistema operativo se conserva después de eliminar la máquina virtual. El valor predeterminado se establece en Desasociar. Para un disco de sistema operativo efímero, el valor predeterminado se establece en Eliminar. El usuario no puede cambiar la opción de eliminación de un disco de sistema operativo efímero.

Nombre	Tipo	Description
Delete	string
Detach	string

DiskDetachOptionTypes

Especifica el comportamiento de desasociación que se va a usar al desasociar un disco o que ya está en proceso de desasociación de la máquina virtual. Valores admitidos: ForceDetach. detachOption: ForceDetach solo se aplica a discos de datos administrados. Si un intento anterior de desasociación del disco de datos no se completó debido a un error inesperado de la máquina virtual y el disco todavía no se libera, use la opción forzar la desasociación como última opción de recurso para separar el disco forzadamente de la máquina virtual. Es posible que todas las escrituras no se hayan vaciado al usar este comportamiento de desasociación. Para forzar la desasociación de una actualización del disco de datos aBeDetached a "true" junto con la configuración de detachOption: "ForceDetach".

Nombre	Tipo	Description
ForceDetach	string

DiskEncryptionSetParameters

Especifica el identificador de recurso del conjunto de cifrado de disco administrado del cliente para el disco administrado.

Nombre	Tipo	Description
id	string	Identificador de recurso

DiskEncryptionSettings

Especifica la configuración de cifrado del disco del sistema operativo. Versión mínima de api: 2015-06-15.

Nombre	Tipo	Description
diskEncryptionKey	KeyVaultSecretReference	Especifica la ubicación de la clave de cifrado de disco, que es un secreto de Key Vault.
enabled	boolean	Especifica si se debe habilitar el cifrado de disco en la máquina virtual.
keyEncryptionKey	KeyVaultKeyReference	Especifica la ubicación de la clave de cifrado de claves en Key Vault.

ImageReference

Especifica información sobre la imagen que se va a usar. Puede especificar información sobre imágenes de plataforma, imágenes de Marketplace o imágenes de máquina virtual. Este elemento es necesario cuando desea usar una imagen de plataforma, una imagen de Marketplace o una imagen de máquina virtual, pero no se usa en otras operaciones de creación.

Nombre	Tipo	Description
communityGalleryImageId	string	Se especificó el identificador único de la imagen de la galería de la comunidad para la implementación de la máquina virtual. Esto se puede capturar desde la llamada GET de la imagen de la galería de la comunidad.
exactVersion	string	Especifica en números decimales, la versión de la imagen de plataforma o la imagen de Marketplace que se usa para crear la máquina virtual. Este campo de solo lectura difiere de "version", solo si el valor especificado en el campo "version" es "latest".
id	string	Identificador de recurso
offer	string	Especifica la oferta de la imagen de plataforma o la imagen de Marketplace que se usa para crear la máquina virtual.
publisher	string	Publicador de imágenes.
sharedGalleryImageId	string	Se especificó el identificador único de la imagen de la galería compartida para la implementación de la máquina virtual. Esto se puede capturar desde la llamada GET de la imagen de la galería compartida.
sku	string	SKU de imagen.
version	string	Especifica la versión de la imagen de plataforma o la imagen de Marketplace que se usa para crear la máquina virtual. Los formatos permitidos son Major.Minor.Build o "latest". Major, Minor y Build son números decimales. Especifique "latest" para usar la versión más reciente de una imagen disponible en tiempo de implementación. Incluso si usa "latest", la imagen de máquina virtual no se actualizará automáticamente después del tiempo de implementación incluso si hay disponible una nueva versión. No use el campo "version" para la implementación de imágenes de la galería, la imagen de la galería siempre debe usar el campo "id" para la implementación, para usar la versión "latest" de la imagen de la galería, simplemente establezca "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/{imageName}" en el campo "id" sin entrada de versión.

InnerError

Detalles del error interno.

Nombre	Tipo	Description
errordetail	string	Mensaje de error interno o volcado de memoria de excepciones.
exceptiontype	string	Tipo de excepción.

KeyVaultKeyReference

Especifica la ubicación de la clave de cifrado de claves en Key Vault.

Nombre	Tipo	Description
keyUrl	string	Dirección URL que hace referencia a una clave de cifrado de claves en Key Vault.
sourceVault	SubResource	Dirección URL relativa del almacén de claves que contiene la clave.

KeyVaultSecretReference

Especifica la ubicación de la clave de cifrado de disco, que es un secreto de Key Vault.

Nombre	Tipo	Description
secretUrl	string	Dirección URL que hace referencia a un secreto en un almacén de claves.
sourceVault	SubResource	Dirección URL relativa del almacén de claves que contiene el secreto.

ManagedDiskParameters

Parámetros de disco administrado.

Nombre	Tipo	Description
diskEncryptionSet	DiskEncryptionSetParameters	Especifica el identificador de recurso del conjunto de cifrado de disco administrado del cliente para el disco administrado.
id	string	Identificador de recurso
securityProfile	VMDiskSecurityProfile	Especifica el perfil de seguridad del disco administrado.
storageAccountType	StorageAccountTypes	Especifica el tipo de cuenta de almacenamiento para el disco administrado. NOTA: UltraSSD_LRS solo se puede usar con discos de datos, no se puede usar con disco del sistema operativo.

OperatingSystemTypes

Tipo de sistema operativo.

Nombre	Tipo	Description
Linux	string
Windows	string

OSDisk

Especifica información sobre el disco del sistema operativo utilizado por la máquina virtual. Para más información sobre los discos, consulte Acerca de discos y discos duros virtuales para máquinas virtuales de Azure.

Nombre	Tipo	Description
caching	CachingTypes	Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None,ReadOnly,ReadWrite. El comportamiento predeterminado es: Ninguno para el almacenamiento estándar. ReadOnly para Premium Storage.
createOption	DiskCreateOptionTypes	Especifica cómo se debe crear el disco de máquina virtual. Los valores posibles son Adjuntar: Este valor se usa cuando se usa un disco especializado para crear la máquina virtual. FromImage: Este valor se usa cuando se usa una imagen para crear la máquina virtual. Si usa una imagen de plataforma, también debe usar el elemento imageReference descrito anteriormente. Si usa una imagen de Marketplace, también debe usar el elemento plan descrito anteriormente.
deleteOption	DiskDeleteOptionTypes	Especifica si el disco del sistema operativo se debe eliminar o desasociar tras la eliminación de la máquina virtual. Los valores posibles son: Delete. Si se usa este valor, el disco del sistema operativo se elimina cuando se elimina la máquina virtual. Separar. Si se usa este valor, el disco del sistema operativo se conserva después de eliminar la máquina virtual. El valor predeterminado se establece en Desasociar. Para un disco de sistema operativo efímero, el valor predeterminado se establece en Eliminar. El usuario no puede cambiar la opción de eliminación de un disco de sistema operativo efímero.
diffDiskSettings	DiffDiskSettings	Especifica la configuración de disco efímero para el disco del sistema operativo utilizado por la máquina virtual.
diskSizeGB	integer	Especifica el tamaño de un disco de datos vacío en gigabytes. Este elemento se puede usar para sobrescribir el tamaño del disco en una imagen de máquina virtual. La propiedad 'diskSizeGB' es el número de bytes x 1024^3 para el disco y el valor no puede ser mayor que 1023.
encryptionSettings	DiskEncryptionSettings	Especifica la configuración de cifrado del disco del sistema operativo. Versión mínima de api: 2015-06-15.
image	VirtualHardDisk	Disco duro virtual de la imagen de usuario de origen. El disco duro virtual se copiará antes de conectarse a la máquina virtual. Si se proporciona SourceImage, el disco duro virtual de destino no debe existir.
managedDisk	ManagedDiskParameters	Parámetros de disco administrado.
name	string	Nombre del disco.
osType	OperatingSystemTypes	Esta propiedad permite especificar el tipo del sistema operativo que se incluye en el disco si crea una máquina virtual a partir de una imagen de usuario o un VHD especializado. Los valores posibles son: Windows,Linux.
vhd	VirtualHardDisk	Disco duro virtual.
writeAcceleratorEnabled	boolean	Especifica si writeAccelerator debe estar habilitado o deshabilitado en el disco.

securityEncryptionTypes

Especifica encryptionType del disco administrado. Se establece en DiskWithVMGuestState para el cifrado del disco administrado junto con el blob VMGuestState, VMGuestStateOnly para el cifrado de solo el blob VMGuestState y NonPersistedTPM para no conservar el estado de firmware en el blob VMGuestState. Nota: Solo se puede establecer para máquinas virtuales confidenciales.

Nombre	Tipo	Description
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

StorageAccountTypes

Especifica el tipo de cuenta de almacenamiento para el disco administrado. NOTA: UltraSSD_LRS solo se puede usar con discos de datos, no se puede usar con disco del sistema operativo.

Nombre	Tipo	Description
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

StorageProfile

Especifica la configuración de almacenamiento de los discos de máquina virtual.

Nombre	Tipo	Description
dataDisks	DataDisk[]	Especifica los parámetros que se usan para agregar un disco de datos a una máquina virtual. Para más información sobre los discos, consulte Acerca de discos y discos duros virtuales para máquinas virtuales de Azure.
diskControllerType	DiskControllerTypes	Especifica el tipo de controlador de disco configurado para la máquina virtual. Nota: Esta propiedad se establecerá en el tipo de controlador de disco predeterminado si no se especifica que se cree una máquina virtual con "hyperVGeneration" establecido en V2 en función de las funcionalidades del disco del sistema operativo y el tamaño de máquina virtual de la versión mínima de api especificada. Debe desasignar la máquina virtual antes de actualizar su tipo de controlador de disco a menos que actualice el tamaño de la máquina virtual en la configuración de la máquina virtual que desasigna implícitamente y reasigna la máquina virtual. Versión mínima de api: 2022-08-01.
imageReference	ImageReference	Especifica información sobre la imagen que se va a usar. Puede especificar información sobre imágenes de plataforma, imágenes de Marketplace o imágenes de máquina virtual. Este elemento es necesario cuando desea usar una imagen de plataforma, una imagen de Marketplace o una imagen de máquina virtual, pero no se usa en otras operaciones de creación.
osDisk	OSDisk	Especifica información sobre el disco del sistema operativo utilizado por la máquina virtual. Para más información sobre los discos, consulte Acerca de discos y discos duros virtuales para máquinas virtuales de Azure.

SubResource

Nombre	Tipo	Description
id	string	Identificador de recurso

VirtualHardDisk

Disco duro virtual.

Nombre	Tipo	Description
uri	string	Especifica el URI del disco duro virtual.

VMDiskSecurityProfile

Especifica el perfil de seguridad del disco administrado.

Nombre	Tipo	Description
diskEncryptionSet	DiskEncryptionSetParameters	Especifica el identificador de recurso del conjunto de cifrado de disco administrado del cliente para el disco administrado que se usa para el disco de sistema operativo ConfidentialVM cifrado con clave administrada por el cliente y el blob vmGuest.
securityEncryptionType	securityEncryptionTypes	Especifica encryptionType del disco administrado. Se establece en DiskWithVMGuestState para el cifrado del disco administrado junto con el blob VMGuestState, VMGuestStateOnly para el cifrado de solo el blob VMGuestState y NonPersistedTPM para no conservar el estado de firmware en el blob VMGuestState. Nota: Solo se puede establecer para máquinas virtuales confidenciales.