Virtual Machines - Attach Detach Data Disks

Référence

Service:: Compute

Version d'API:: 2024-03-01

Attachez et détachez des disques de données à/à partir de la machine virtuelle.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
vmName	path	True	string	Nom de la machine virtuelle.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Type	Description
parameters	AttachDetachDataDisksRequest	Paramètres fournis pour l’opération attacher et détacher les disques de données sur la machine virtuelle.

Réponses

Nom	Type	Description
200 OK	StorageProfile	D’ACCORD
202 Accepted		Accepté En-têtes Location: string
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Nom

Type

Description

200 OK

StorageProfile

D’ACCORD

202 Accepted

Accepté

En-têtes

Location: string

Other Status Codes

CloudError

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

Exemple de requête

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/aaaaaaaaaaaaaaaaaaaa/attachDetachDataDisks?api-version=2024-03-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"
    }
  ]
}

from typing import Any, IO, Union

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-03-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

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-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

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-03-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

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.Resources;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-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

Exemple de réponse

Code d’état:: 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
    }
  ]
}

Code d’état:: 202

location: https://foo.com/operationstatus

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

Exemple de requête

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/azure-vm/attachDetachDataDisks?api-version=2024-03-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"
    }
  ]
}

from typing import Any, IO, Union

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-03-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

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-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

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-03-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

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.Resources;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-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

Exemple de réponse

Code d’état:: 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
    }
  ]
}

Code d’état:: 202

location: https://foo.com/operationstatus

Définitions

Nom	Description
ApiEntityReference	Identificateur de ressource source. Il peut s’agir d’un instantané ou d’un point de restauration de disque à partir duquel créer un disque.
ApiError	Erreur d’API.
ApiErrorBase	Base d’erreurs d’API.
AttachDetachDataDisksRequest	Paramètres fournis pour l’opération attacher et détacher les disques de données sur la machine virtuelle.
CachingTypes	Spécifie les exigences de mise en cache. Les valeurs possibles sont : None,ReadOnly,ReadWrite. Le comportement par défaut est : None pour le stockage Standard. ReadOnly pour le stockage Premium.
CloudError	Réponse d’erreur du service de calcul.
DataDisk	Spécifie les paramètres utilisés pour ajouter un disque de données à une machine virtuelle. Pour plus d’informations sur les disques, consultez À propos des disques et des disques durs virtuels pour les machines virtuelles Azure.
DataDisksToAttach	Liste des disques de données managés à joindre.
DataDisksToDetach	Liste des disques de données managés à détacher.
DiffDiskOptions	Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation.
DiffDiskPlacement	Spécifie le placement de disque éphémère pour le disque du système d’exploitation. Les valeurs possibles sont les suivantes : CacheDisk,ResourceDisk,NvmeDisk. Le comportement par défaut est : CacheDisk si une taille de machine virtuelle est configurée pour la taille de machine virtuelle sinon ResourceDisk ou NvmeDisk est utilisé. Reportez-vous à la documentation sur la taille des machines virtuelles Windows sur https://docs.microsoft.com/azure/virtual-machines/windows/sizes et la machine virtuelle Linux à https://docs.microsoft.com/azure/virtual-machines/linux/sizes pour vérifier quelles tailles de machine virtuelle exposent un disque de cache. Version minimale de l’API pour NvmeDisk : 2024-03-01.
DiffDiskSettings	Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation utilisé par la machine virtuelle.
DiskControllerTypes	Spécifie le type de contrôleur de disque configuré pour la machine virtuelle. Remarque : Cette propriété est définie sur le type de contrôleur de disque par défaut si aucune machine virtuelle fournie n’est créée avec « hyperVGeneration » définie sur V2 en fonction des fonctionnalités du disque du système d’exploitation et de la taille de machine virtuelle à partir de la version minimale spécifiée de l’API. Vous devez libérer la machine virtuelle avant de mettre à jour son type de contrôleur de disque, sauf si vous mettez à jour la taille de machine virtuelle dans la configuration de la machine virtuelle qui désalloue et réalloue implicitement la machine virtuelle. Version minimale de l’API : 2022-08-01.
DiskCreateOptionTypes	Spécifie la façon dont le disque de machine virtuelle doit être créé. Les valeurs possibles sont Attacher : Cette valeur est utilisée lorsque vous utilisez un disque spécialisé pour créer la machine virtuelle. FromImage : Cette valeur est utilisée lorsque vous utilisez une image pour créer la machine virtuelle. Si vous utilisez une image de plateforme, vous devez également utiliser l’élément imageReference décrit ci-dessus. Si vous utilisez une image de la Place de marché, vous devez également utiliser l’élément de plan décrit précédemment.
DiskDeleteOptionTypes	Spécifie si le disque du système d’exploitation doit être supprimé ou détaché lors de la suppression de la machine virtuelle. Les valeurs possibles sont les suivantes : Supprimer. Si cette valeur est utilisée, le disque du système d’exploitation est supprimé lorsque la machine virtuelle est supprimée. Détacher. Si cette valeur est utilisée, le disque du système d’exploitation est conservé après la suppression de la machine virtuelle. La valeur par défaut est définie sur détacher. Pour un disque de système d’exploitation éphémère, la valeur par défaut est définie sur Supprimer. L’utilisateur ne peut pas modifier l’option de suppression d’un disque de système d’exploitation éphémère.
DiskDetachOptionTypes	Spécifie le comportement de détachement à utiliser lors du détachement d’un disque ou déjà en cours de détachement de la machine virtuelle. Valeurs prises en charge : ForceDetach. détacherOption : ForceDetach s’applique uniquement aux disques de données managés. Si une tentative de détachement précédente du disque de données n’a pas été effectuée en raison d’une défaillance inattendue de la machine virtuelle et que le disque n’est toujours pas libéré, utilisez une option de détachement forcé comme option de dernier recours pour détacher le disque de force de la machine virtuelle. Toutes les écritures n’ont peut-être pas été vidées lors de l’utilisation de ce comportement de détachement. Cette fonctionnalité est toujours en mode préversion et n’est pas prise en charge pour VirtualMachineScaleSet. Pour forcer le détachement d’une mise à jour du disque de données versBeDetached à « true », ainsi que le paramètre detachOption : « ForceDetach ».
DiskEncryptionSetParameters	Spécifie l’ID de ressource du jeu de chiffrement de disque managé du client pour le disque managé.
DiskEncryptionSettings	Spécifie les paramètres de chiffrement du disque du système d’exploitation. Version minimale de l’API : 2015-06-15.
ImageReference	Spécifie des informations sur l’image à utiliser. Vous pouvez spécifier des informations sur les images de plateforme, les images de la Place de marché ou les images de machine virtuelle. Cet élément est requis lorsque vous souhaitez utiliser une image de plateforme, une image de la Place de marché ou une image de machine virtuelle, mais n’est pas utilisé dans d’autres opérations de création.
InnerError	Détails de l’erreur interne.
KeyVaultKeyReference	Spécifie l’emplacement de la clé de chiffrement de clé dans Key Vault.
KeyVaultSecretReference	Spécifie l’emplacement de la clé de chiffrement de disque, qui est un secret Key Vault.
ManagedDiskParameters	Paramètres de disque managé.
OperatingSystemTypes	Type de système d’exploitation.
OSDisk	Spécifie des informations sur le disque du système d’exploitation utilisé par la machine virtuelle. Pour plus d’informations sur les disques, consultez À propos des disques et des disques durs virtuels pour les machines virtuelles Azure.
securityEncryptionTypes	Spécifie le EncryptionType du disque managé. Il est défini sur DiskWithVMGuestState pour le chiffrement du disque managé avec l’objet blob VMGuestState, VMGuestStateOnly pour le chiffrement de l’objet blob VMGuestState et nonPersistedTPM pour ne pas conserver l’état du microprogramme dans l’objet blob VMGuestState.. Remarque : Il peut être défini uniquement pour les machines virtuelles confidentielles.
StorageAccountTypes	Spécifie le type de compte de stockage pour le disque managé. REMARQUE : UltraSSD_LRS ne peut être utilisé qu’avec des disques de données, il ne peut pas être utilisé avec le disque du système d’exploitation.
StorageProfile	Spécifie les paramètres de stockage des disques de machine virtuelle.
SubResource
VirtualHardDisk	Disque dur virtuel.
VMDiskSecurityProfile	Spécifie le profil de sécurité du disque managé.

ApiEntityReference

Identificateur de ressource source. Il peut s’agir d’un instantané ou d’un point de restauration de disque à partir duquel créer un disque.

Nom	Type	Description
id	string	ID de ressource ARM sous la forme de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Erreur d’API.

Nom	Type	Description
code	string	Code d’erreur.
details	ApiErrorBase[]	Détails de l’erreur api
innererror	InnerError	Erreur interne de l’API
message	string	Message d’erreur.
target	string	Cible de l’erreur particulière.

ApiErrorBase

Base d’erreurs d’API.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur.
target	string	Cible de l’erreur particulière.

AttachDetachDataDisksRequest

Paramètres fournis pour l’opération attacher et détacher les disques de données sur la machine virtuelle.

Nom	Type	Description
dataDisksToAttach	DataDisksToAttach[]	Liste des disques de données managés à joindre.
dataDisksToDetach	DataDisksToDetach[]	Liste des disques de données managés à détacher.

CachingTypes

Spécifie les exigences de mise en cache. Les valeurs possibles sont : None,ReadOnly,ReadWrite. Le comportement par défaut est : None pour le stockage Standard. ReadOnly pour le stockage Premium.

Nom	Type	Description
None	string
ReadOnly	string
ReadWrite	string

CloudError

Réponse d’erreur du service de calcul.

Nom	Type	Description
error	ApiError	Erreur d’API.

DataDisk

Spécifie les paramètres utilisés pour ajouter un disque de données à une machine virtuelle. Pour plus d’informations sur les disques, consultez À propos des disques et des disques durs virtuels pour les machines virtuelles Azure.

Nom	Type	Description
caching	CachingTypes	Spécifie les exigences de mise en cache. Les valeurs possibles sont : None,ReadOnly,ReadWrite. Le comportement par défaut est : None pour le stockage Standard. ReadOnly pour le stockage Premium.
createOption	DiskCreateOptionTypes	Spécifie la façon dont le disque de machine virtuelle doit être créé. Les valeurs possibles sont Attacher : Cette valeur est utilisée lorsque vous utilisez un disque spécialisé pour créer la machine virtuelle. FromImage : Cette valeur est utilisée lorsque vous utilisez une image pour créer le disque de données de machine virtuelle. Si vous utilisez une image de plateforme, vous devez également utiliser l’élément imageReference décrit ci-dessus. Si vous utilisez une image de la Place de marché, vous devez également utiliser l’élément de plan décrit précédemment. Vide : Cette valeur est utilisée lors de la création d’un disque de données vide. Copier : Cette valeur est utilisée pour créer un disque de données à partir d’un instantané ou d’un autre disque. Restauration : Cette valeur est utilisée pour créer un disque de données à partir d’un point de restauration de disque.
deleteOption	DiskDeleteOptionTypes	Spécifie si le disque de données doit être supprimé ou détaché lors de la suppression de la machine virtuelle. Les valeurs possibles sont les suivantes : Supprimer. Si cette valeur est utilisée, le disque de données est supprimé lorsque la machine virtuelle est supprimée. Détacher. Si cette valeur est utilisée, le disque de données est conservé après la suppression de la machine virtuelle. La valeur par défaut est définie sur détacher.
detachOption	DiskDetachOptionTypes	Spécifie le comportement de détachement à utiliser lors du détachement d’un disque ou déjà en cours de détachement de la machine virtuelle. Valeurs prises en charge : ForceDetach. détacherOption : ForceDetach s’applique uniquement aux disques de données managés. Si une tentative de détachement précédente du disque de données n’a pas été effectuée en raison d’une défaillance inattendue de la machine virtuelle et que le disque n’est toujours pas libéré, utilisez une option de détachement forcé comme option de dernier recours pour détacher le disque de force de la machine virtuelle. Toutes les écritures n’ont peut-être pas été vidées lors de l’utilisation de ce comportement de détachement. Cette fonctionnalité est toujours en mode préversion et n’est pas prise en charge pour VirtualMachineScaleSet. Pour forcer le détachement d’une mise à jour du disque de données versBeDetached à « true », ainsi que le paramètre detachOption : « ForceDetach ».
diskIOPSReadWrite	integer	Spécifie l’IOPS Read-Write pour le disque managé lorsque StorageAccountType est UltraSSD_LRS. Retourné uniquement pour les disques de machine virtuelle VirtualMachine ScaleSet. Peut être mis à jour uniquement par le biais de mises à jour du groupe identique VirtualMachine.
diskMBpsReadWrite	integer	Spécifie la bande passante en Mo par seconde pour le disque managé lorsque StorageAccountType est UltraSSD_LRS. Retourné uniquement pour les disques de machine virtuelle VirtualMachine ScaleSet. Peut être mis à jour uniquement par le biais de mises à jour du groupe identique VirtualMachine.
diskSizeGB	integer	Spécifie la taille d’un disque de données vide en gigaoctets. Cet élément peut être utilisé pour remplacer la taille du disque dans une image de machine virtuelle. La propriété « diskSizeGB » est le nombre d’octets x 1024^3 pour le disque et la valeur ne peut pas être supérieure à 1023.
image	VirtualHardDisk	Disque dur virtuel de l’image utilisateur source. Le disque dur virtuel est copié avant d’être attaché à la machine virtuelle. Si SourceImage est fourni, le disque dur virtuel de destination ne doit pas exister.
lun	integer	Spécifie le numéro d’unité logique du disque de données. Cette valeur est utilisée pour identifier les disques de données au sein de la machine virtuelle et doit donc être unique pour chaque disque de données attaché à une machine virtuelle.
managedDisk	ManagedDiskParameters	Paramètres de disque managé.
name	string	Nom du disque.
sourceResource	ApiEntityReference	Identificateur de ressource source. Il peut s’agir d’un instantané ou d’un point de restauration de disque à partir duquel créer un disque.
toBeDetached	boolean	Spécifie si le disque de données est en cours de détachement à partir de VirtualMachine/VirtualMachineScaleset
vhd	VirtualHardDisk	Disque dur virtuel.
writeAcceleratorEnabled	boolean	Spécifie si writeAccelerator doit être activé ou désactivé sur le disque.

DataDisksToAttach

Liste des disques de données managés à joindre.

Nom	Type	Description
caching	CachingTypes	Spécifie les exigences de mise en cache. Les valeurs possibles sont : None,ReadOnly,ReadWrite. Le comportement par défaut est : None pour le stockage Standard. ReadOnly pour le stockage Premium.
deleteOption	DiskDeleteOptionTypes	Spécifie si le disque de données doit être supprimé ou détaché lors de la suppression de la machine virtuelle. Les valeurs possibles sont les suivantes : Supprimer. Si cette valeur est utilisée, le disque de données est supprimé lorsque la machine virtuelle est supprimée. Détacher. Si cette valeur est utilisée, le disque de données est conservé après la suppression de la machine virtuelle. La valeur par défaut est définie sur détacher.
diskEncryptionSet	DiskEncryptionSetParameters	Spécifie l’ID de ressource du jeu de chiffrement de disque managé du client pour le disque managé.
diskId	string	ID du disque de données managé.
lun	integer	Numéro d’unité logique du disque de données. Cette valeur est utilisée pour identifier les disques de données au sein de la machine virtuelle et doit donc être unique pour chaque disque de données attaché à une machine virtuelle. S’il n’est pas spécifié, lun est attribué automatiquement.
writeAcceleratorEnabled	boolean	Spécifie si writeAccelerator doit être activé ou désactivé sur le disque.

DataDisksToDetach

Liste des disques de données managés à détacher.

Nom	Type	Description
detachOption	DiskDetachOptionTypes	Options prises en charge pour détacher un disque d’une machine virtuelle. Pour plus d’informations, reportez-vous à la référence de l’objet DetachOption.
diskId	string	ID du disque de données managé.

DiffDiskOptions

Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation.

Nom	Type	Description
Local	string

DiffDiskPlacement

Spécifie le placement de disque éphémère pour le disque du système d’exploitation. Les valeurs possibles sont les suivantes : CacheDisk,ResourceDisk,NvmeDisk. Le comportement par défaut est : CacheDisk si une taille de machine virtuelle est configurée pour la taille de machine virtuelle sinon ResourceDisk ou NvmeDisk est utilisé. Reportez-vous à la documentation sur la taille des machines virtuelles Windows sur https://docs.microsoft.com/azure/virtual-machines/windows/sizes et la machine virtuelle Linux à https://docs.microsoft.com/azure/virtual-machines/linux/sizes pour vérifier quelles tailles de machine virtuelle exposent un disque de cache. Version minimale de l’API pour NvmeDisk : 2024-03-01.

Nom	Type	Description
CacheDisk	string
NvmeDisk	string
ResourceDisk	string

DiffDiskSettings

Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation utilisé par la machine virtuelle.

Nom	Type	Description
option	DiffDiskOptions	Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation.
placement	DiffDiskPlacement	Spécifie le placement de disque éphémère pour le disque du système d’exploitation. Les valeurs possibles sont les suivantes : CacheDisk,ResourceDisk,NvmeDisk. Le comportement par défaut est : CacheDisk si une taille de machine virtuelle est configurée pour la taille de machine virtuelle sinon ResourceDisk ou NvmeDisk est utilisé. Reportez-vous à la documentation sur la taille des machines virtuelles Windows sur https://docs.microsoft.com/azure/virtual-machines/windows/sizes et la machine virtuelle Linux à https://docs.microsoft.com/azure/virtual-machines/linux/sizes pour vérifier quelles tailles de machine virtuelle exposent un disque de cache. Version minimale de l’API pour NvmeDisk : 2024-03-01.

DiskControllerTypes

Spécifie le type de contrôleur de disque configuré pour la machine virtuelle. Remarque : Cette propriété est définie sur le type de contrôleur de disque par défaut si aucune machine virtuelle fournie n’est créée avec « hyperVGeneration » définie sur V2 en fonction des fonctionnalités du disque du système d’exploitation et de la taille de machine virtuelle à partir de la version minimale spécifiée de l’API. Vous devez libérer la machine virtuelle avant de mettre à jour son type de contrôleur de disque, sauf si vous mettez à jour la taille de machine virtuelle dans la configuration de la machine virtuelle qui désalloue et réalloue implicitement la machine virtuelle. Version minimale de l’API : 2022-08-01.

Nom	Type	Description
NVMe	string
SCSI	string

DiskCreateOptionTypes

Spécifie la façon dont le disque de machine virtuelle doit être créé. Les valeurs possibles sont Attacher : Cette valeur est utilisée lorsque vous utilisez un disque spécialisé pour créer la machine virtuelle. FromImage : Cette valeur est utilisée lorsque vous utilisez une image pour créer la machine virtuelle. Si vous utilisez une image de plateforme, vous devez également utiliser l’élément imageReference décrit ci-dessus. Si vous utilisez une image de la Place de marché, vous devez également utiliser l’élément de plan décrit précédemment.

Nom	Type	Description
Attach	string
Copy	string
Empty	string
FromImage	string
Restore	string

DiskDeleteOptionTypes

Spécifie si le disque du système d’exploitation doit être supprimé ou détaché lors de la suppression de la machine virtuelle. Les valeurs possibles sont les suivantes : Supprimer. Si cette valeur est utilisée, le disque du système d’exploitation est supprimé lorsque la machine virtuelle est supprimée. Détacher. Si cette valeur est utilisée, le disque du système d’exploitation est conservé après la suppression de la machine virtuelle. La valeur par défaut est définie sur détacher. Pour un disque de système d’exploitation éphémère, la valeur par défaut est définie sur Supprimer. L’utilisateur ne peut pas modifier l’option de suppression d’un disque de système d’exploitation éphémère.

Nom	Type	Description
Delete	string
Detach	string

DiskDetachOptionTypes

Spécifie le comportement de détachement à utiliser lors du détachement d’un disque ou déjà en cours de détachement de la machine virtuelle. Valeurs prises en charge : ForceDetach. détacherOption : ForceDetach s’applique uniquement aux disques de données managés. Si une tentative de détachement précédente du disque de données n’a pas été effectuée en raison d’une défaillance inattendue de la machine virtuelle et que le disque n’est toujours pas libéré, utilisez une option de détachement forcé comme option de dernier recours pour détacher le disque de force de la machine virtuelle. Toutes les écritures n’ont peut-être pas été vidées lors de l’utilisation de ce comportement de détachement. Cette fonctionnalité est toujours en mode préversion et n’est pas prise en charge pour VirtualMachineScaleSet. Pour forcer le détachement d’une mise à jour du disque de données versBeDetached à « true », ainsi que le paramètre detachOption : « ForceDetach ».

Nom	Type	Description
ForceDetach	string

DiskEncryptionSetParameters

Spécifie l’ID de ressource du jeu de chiffrement de disque managé du client pour le disque managé.

Nom	Type	Description
id	string	ID de ressource

DiskEncryptionSettings

Spécifie les paramètres de chiffrement du disque du système d’exploitation. Version minimale de l’API : 2015-06-15.

Nom	Type	Description
diskEncryptionKey	KeyVaultSecretReference	Spécifie l’emplacement de la clé de chiffrement de disque, qui est un secret Key Vault.
enabled	boolean	Spécifie si le chiffrement de disque doit être activé sur la machine virtuelle.
keyEncryptionKey	KeyVaultKeyReference	Spécifie l’emplacement de la clé de chiffrement de clé dans Key Vault.

ImageReference

Spécifie des informations sur l’image à utiliser. Vous pouvez spécifier des informations sur les images de plateforme, les images de la Place de marché ou les images de machine virtuelle. Cet élément est requis lorsque vous souhaitez utiliser une image de plateforme, une image de la Place de marché ou une image de machine virtuelle, mais n’est pas utilisé dans d’autres opérations de création.

Nom	Type	Description
communityGalleryImageId	string	Spécifie l’ID unique de l’image de la galerie de communautés pour le déploiement de machines virtuelles. Cette opération peut être extraite de l’appel GET de la galerie de la communauté.
exactVersion	string	Spécifie en nombres décimaux, la version de l’image de plateforme ou de la place de marché utilisée pour créer la machine virtuelle. Ce champ en lecture seule diffère de « version », uniquement si la valeur spécifiée dans le champ « version » est « latest ».
id	string	ID de ressource
offer	string	Spécifie l’offre de l’image de plateforme ou de la place de marché utilisée pour créer la machine virtuelle.
publisher	string	Éditeur d’images.
sharedGalleryImageId	string	Spécifie l’ID unique de l’image de galerie partagée pour le déploiement de machines virtuelles. Cette opération peut être extraite de l’appel GET de l’image de galerie partagée.
sku	string	Référence SKU d’image.
version	string	Spécifie la version de l’image de plateforme ou de la place de marché utilisée pour créer la machine virtuelle. Les formats autorisés sont Major.Minor.Build ou « latest ». Les nombres principaux, mineurs et build sont des nombres décimaux. Spécifiez « latest » pour utiliser la dernière version d’une image disponible au moment du déploiement. Même si vous utilisez la « dernière version », l’image de machine virtuelle ne sera pas automatiquement mise à jour après le déploiement même si une nouvelle version devient disponible. N’utilisez pas le champ « version » pour le déploiement d’images de galerie, l’image de la galerie doit toujours utiliser le champ « ID » pour le déploiement, pour utiliser la version la plus récente de l’image de la galerie, il vous suffit de définir « /subscriptions/{subscriptionId}/resourceGroupName}/{resourceGroupName}/providers/Microsoft.Compute/galleryName}/images/{imageName} » dans le champ « id » sans entrée de version.

InnerError

Détails de l’erreur interne.

Nom	Type	Description
errordetail	string	Message d’erreur interne ou vidage d’exception.
exceptiontype	string	Type d’exception.

KeyVaultKeyReference

Spécifie l’emplacement de la clé de chiffrement de clé dans Key Vault.

Nom	Type	Description
keyUrl	string	URL référençant une clé de chiffrement de clé dans Key Vault.
sourceVault	SubResource	URL relative du coffre de clés contenant la clé.

KeyVaultSecretReference

Spécifie l’emplacement de la clé de chiffrement de disque, qui est un secret Key Vault.

Nom	Type	Description
secretUrl	string	URL référençant un secret dans un coffre de clés.
sourceVault	SubResource	URL relative du coffre de clés contenant le secret.

ManagedDiskParameters

Paramètres de disque managé.

Nom	Type	Description
diskEncryptionSet	DiskEncryptionSetParameters	Spécifie l’ID de ressource du jeu de chiffrement de disque managé du client pour le disque managé.
id	string	ID de ressource
securityProfile	VMDiskSecurityProfile	Spécifie le profil de sécurité du disque managé.
storageAccountType	StorageAccountTypes	Spécifie le type de compte de stockage pour le disque managé. REMARQUE : UltraSSD_LRS ne peut être utilisé qu’avec des disques de données, il ne peut pas être utilisé avec le disque du système d’exploitation.

OperatingSystemTypes

Type de système d’exploitation.

Nom	Type	Description
Linux	string
Windows	string

OSDisk

Spécifie des informations sur le disque du système d’exploitation utilisé par la machine virtuelle. Pour plus d’informations sur les disques, consultez À propos des disques et des disques durs virtuels pour les machines virtuelles Azure.

Nom	Type	Description
caching	CachingTypes	Spécifie les exigences de mise en cache. Les valeurs possibles sont : None,ReadOnly,ReadWrite. Le comportement par défaut est : None pour le stockage Standard. ReadOnly pour le stockage Premium.
createOption	DiskCreateOptionTypes	Spécifie la façon dont le disque de machine virtuelle doit être créé. Les valeurs possibles sont Attacher : Cette valeur est utilisée lorsque vous utilisez un disque spécialisé pour créer la machine virtuelle. FromImage : Cette valeur est utilisée lorsque vous utilisez une image pour créer la machine virtuelle. Si vous utilisez une image de plateforme, vous devez également utiliser l’élément imageReference décrit ci-dessus. Si vous utilisez une image de la Place de marché, vous devez également utiliser l’élément de plan décrit précédemment.
deleteOption	DiskDeleteOptionTypes	Spécifie si le disque du système d’exploitation doit être supprimé ou détaché lors de la suppression de la machine virtuelle. Les valeurs possibles sont les suivantes : Supprimer. Si cette valeur est utilisée, le disque du système d’exploitation est supprimé lorsque la machine virtuelle est supprimée. Détacher. Si cette valeur est utilisée, le disque du système d’exploitation est conservé après la suppression de la machine virtuelle. La valeur par défaut est définie sur détacher. Pour un disque de système d’exploitation éphémère, la valeur par défaut est définie sur Supprimer. L’utilisateur ne peut pas modifier l’option de suppression d’un disque de système d’exploitation éphémère.
diffDiskSettings	DiffDiskSettings	Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation utilisé par la machine virtuelle.
diskSizeGB	integer	Spécifie la taille d’un disque de données vide en gigaoctets. Cet élément peut être utilisé pour remplacer la taille du disque dans une image de machine virtuelle. La propriété « diskSizeGB » est le nombre d’octets x 1024^3 pour le disque et la valeur ne peut pas être supérieure à 1023.
encryptionSettings	DiskEncryptionSettings	Spécifie les paramètres de chiffrement du disque du système d’exploitation. Version minimale de l’API : 2015-06-15.
image	VirtualHardDisk	Disque dur virtuel de l’image utilisateur source. Le disque dur virtuel est copié avant d’être attaché à la machine virtuelle. Si SourceImage est fourni, le disque dur virtuel de destination ne doit pas exister.
managedDisk	ManagedDiskParameters	Paramètres de disque managé.
name	string	Nom du disque.
osType	OperatingSystemTypes	Cette propriété vous permet de spécifier le type du système d’exploitation inclus dans le disque si vous créez une machine virtuelle à partir d’une image utilisateur ou d’un disque dur virtuel spécialisé. Les valeurs possibles sont : Windows,Linux.
vhd	VirtualHardDisk	Disque dur virtuel.
writeAcceleratorEnabled	boolean	Spécifie si writeAccelerator doit être activé ou désactivé sur le disque.

securityEncryptionTypes

Spécifie le EncryptionType du disque managé. Il est défini sur DiskWithVMGuestState pour le chiffrement du disque managé avec l’objet blob VMGuestState, VMGuestStateOnly pour le chiffrement de l’objet blob VMGuestState et nonPersistedTPM pour ne pas conserver l’état du microprogramme dans l’objet blob VMGuestState.. Remarque : Il peut être défini uniquement pour les machines virtuelles confidentielles.

Nom	Type	Description
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

StorageAccountTypes

Spécifie le type de compte de stockage pour le disque managé. REMARQUE : UltraSSD_LRS ne peut être utilisé qu’avec des disques de données, il ne peut pas être utilisé avec le disque du système d’exploitation.

Nom	Type	Description
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

StorageProfile

Spécifie les paramètres de stockage des disques de machine virtuelle.

Nom	Type	Description
dataDisks	DataDisk[]	Spécifie les paramètres utilisés pour ajouter un disque de données à une machine virtuelle. Pour plus d’informations sur les disques, consultez À propos des disques et des disques durs virtuels pour les machines virtuelles Azure.
diskControllerType	DiskControllerTypes	Spécifie le type de contrôleur de disque configuré pour la machine virtuelle. Remarque : Cette propriété est définie sur le type de contrôleur de disque par défaut si aucune machine virtuelle fournie n’est créée avec « hyperVGeneration » définie sur V2 en fonction des fonctionnalités du disque du système d’exploitation et de la taille de machine virtuelle à partir de la version minimale spécifiée de l’API. Vous devez libérer la machine virtuelle avant de mettre à jour son type de contrôleur de disque, sauf si vous mettez à jour la taille de machine virtuelle dans la configuration de la machine virtuelle qui désalloue et réalloue implicitement la machine virtuelle. Version minimale de l’API : 2022-08-01.
imageReference	ImageReference	Spécifie des informations sur l’image à utiliser. Vous pouvez spécifier des informations sur les images de plateforme, les images de la Place de marché ou les images de machine virtuelle. Cet élément est requis lorsque vous souhaitez utiliser une image de plateforme, une image de la Place de marché ou une image de machine virtuelle, mais n’est pas utilisé dans d’autres opérations de création.
osDisk	OSDisk	Spécifie des informations sur le disque du système d’exploitation utilisé par la machine virtuelle. Pour plus d’informations sur les disques, consultez À propos des disques et des disques durs virtuels pour les machines virtuelles Azure.

SubResource

Nom	Type	Description
id	string	ID de ressource

VirtualHardDisk

Disque dur virtuel.

Nom	Type	Description
uri	string	Spécifie l’URI du disque dur virtuel.

VMDiskSecurityProfile

Spécifie le profil de sécurité du disque managé.

Nom	Type	Description
diskEncryptionSet	DiskEncryptionSetParameters	Spécifie l’ID de ressource du jeu de chiffrement de disque managé du client pour le disque managé utilisé pour le disque de système d’exploitation ConfidentielVM chiffré par clé gérée par le client et l’objet blob VMGuest.
securityEncryptionType	securityEncryptionTypes	Spécifie le EncryptionType du disque managé. Il est défini sur DiskWithVMGuestState pour le chiffrement du disque managé avec l’objet blob VMGuestState, VMGuestStateOnly pour le chiffrement de l’objet blob VMGuestState et nonPersistedTPM pour ne pas conserver l’état du microprogramme dans l’objet blob VMGuestState.. Remarque : Il peut être défini uniquement pour les machines virtuelles confidentielles.

Partager via

Virtual Machines - Attach Detach Data Disks

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

Exemple de requête

Exemple de réponse

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

Exemple de requête

Exemple de réponse

Définitions

ApiEntityReference

ApiError

ApiErrorBase

AttachDetachDataDisksRequest

CachingTypes

CloudError

DataDisk

DataDisksToAttach

DataDisksToDetach

DiffDiskOptions

DiffDiskPlacement

DiffDiskSettings

DiskControllerTypes

DiskCreateOptionTypes

DiskDeleteOptionTypes

DiskDetachOptionTypes

DiskEncryptionSetParameters

DiskEncryptionSettings

ImageReference

InnerError

KeyVaultKeyReference

KeyVaultSecretReference

ManagedDiskParameters

OperatingSystemTypes

OSDisk

securityEncryptionTypes

StorageAccountTypes

StorageProfile

SubResource

VirtualHardDisk

VMDiskSecurityProfile

Ressources supplémentaires