你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Virtual Machines - Attach Detach Data Disks

服务:: Compute

API 版本:: 2024-11-01

在虚拟机中附加和分离数据磁盘。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
vmName	path	True	string	虚拟机的名称。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求正文

名称	类型	说明
dataDisksToAttach	DataDisksToAttach[]	要附加的托管数据磁盘的列表。
dataDisksToDetach	DataDisksToDetach[]	要分离的托管数据磁盘列表。

响应

名称	类型	说明
200 OK	StorageProfile	Azure作已成功完成。
202 Accepted		已接受资源作。标头 Location: string Retry-After: integer
Other Status Codes	CloudError	意外的错误响应。

名称

类型

说明

200 OK

StorageProfile

Azure作已成功完成。

202 Accepted

已接受资源作。

标头

Location: string
Retry-After: integer

Other Status Codes

CloudError

意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流程。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

示例请求

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


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

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-11-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/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4517f89a8ebd2f6a94e107e5ee60fff9886f3612/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-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");
require("dotenv/config");

/**
 * 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-11-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.Compute;

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

示例响应

状态代码:: 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
    }
  ]
}

状态代码:: 202

location: https://foo.com/operationstatus

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

示例请求

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


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

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-11-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/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4517f89a8ebd2f6a94e107e5ee60fff9886f3612/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-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");
require("dotenv/config");

/**
 * 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-11-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.Compute;

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

示例响应

状态代码:: 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
    }
  ]
}

状态代码:: 202

location: https://foo.com/operationstatus

定义

名称	说明
ApiEntityReference	API 实体引用。
ApiError	Api 错误。
ApiErrorBase	Api 错误基数。
AttachDetachDataDisksRequest	指定用于附加和分离托管数据磁盘列表的输入。
CachingTypes	指定缓存要求。可能的值为： None、ReadOnly、ReadWrite。默认值为： Standard storage 的 None。高级存储的 ReadOnly
CloudError	来自计算服务的错误响应。
DataDisk	描述数据磁盘。
DataDisksToAttach	描述要附加的数据磁盘。
DataDisksToDetach	描述要分离的数据磁盘。
DiffDiskOptions	指定操作系统磁盘的临时磁盘选项。
DiffDiskPlacement	指定操作系统磁盘的临时磁盘放置。用户可以在请求中使用此属性来选择用于临时 OS 磁盘预配的位置，例如缓存磁盘、资源磁盘或 nvme 磁盘空间。有关临时 OS 磁盘大小要求的详细信息，请参阅上的 https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements Windows VM 和 Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements的临时 OS 磁盘大小要求。 NvmeDisk 的最低 API 版本：2024-03-01。
DiffDiskSettings	描述可为操作系统磁盘指定的临时磁盘设置的参数。注意：临时磁盘设置只能为托管磁盘指定。
DiskControllerTypes	指定为 VM 和 VirtualMachineScaleSet 配置的磁盘控制器类型。只有操作系统磁盘和 VM SKU 支持第 2 代（https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2）的虚拟机才支持此属性，请在响应区域的 Microsoft.Compute SKU API 包含 V2（https://docs.microsoft.com/rest/api/compute/resourceskus/list）时检查作为 VM SKU 功能的一部分返回的 HyperVGenerations 功能。有关支持的磁盘控制器类型的详细信息，请参阅 https://aka.ms/azure-diskcontrollertypes。
DiskCreateOptionTypes	指定应如何创建虚拟机磁盘。可能的值是附加：使用专用磁盘创建虚拟机时，将使用此值。 FromImage：使用映像创建虚拟机时使用此值。如果使用平台映像，还应使用上述 imageReference 元素。如果使用市场映像，还应使用前面所述的计划元素。空：创建空数据磁盘时使用此值。复制：此值用于从快照或其他磁盘创建数据磁盘。还原：此值用于从磁盘还原点创建数据磁盘。
DiskDeleteOptionTypes	指定删除 VM 时托管磁盘的行为，例如是删除还是分离托管磁盘。支持的值为：Delete。如果使用此值，则会在删除 VM 时删除托管磁盘。分离。如果使用此值，则会在删除 VM 后保留托管磁盘。最低 API 版本：2021-03-01。
DiskDetachOptionTypes	指定要在分离磁盘时使用的分离行为，或者已在从虚拟机分离过程中使用。支持的值为： ForceDetach。 detachOption： ForceDetach 仅适用于托管数据磁盘。如果以前由于虚拟机意外故障而未完成数据磁盘的分离尝试，并且磁盘仍未释放，则使用强制分离作为最后手段选项从 VM 强行分离磁盘。使用此分离行为时，可能不会刷新所有写入。此功能仍处于预览阶段。若要强制分离数据磁盘更新到BeDetached 到“true”，以及设置 detachOption：“ForceDetach”。
DiskEncryptionSetParameters	描述可为磁盘指定的客户托管磁盘加密集资源 ID 的参数。注意：只能为托管磁盘指定磁盘加密集资源 ID。有关详细信息，请参阅 https://aka.ms/mdssewithcmkoverview。
DiskEncryptionSettings	描述磁盘的加密设置
ImageReference	指定要使用的图像的信息。可以指定有关平台映像、市场映像或虚拟机映像的信息。若要使用平台映像、市场映像或虚拟机映像，但不在其他创建操作中使用，则需要此元素。注意：只能在创建规模集时设置映像引用发布者和产品/服务。
InnerError	内部错误详细信息。
KeyVaultKeyReference	描述对 Key Vault 密钥的引用
KeyVaultSecretReference	描述对 Key Vault 机密的引用
ManagedDiskParameters	托管磁盘的参数。
OperatingSystemTypes	此属性允许指定从用户映像或专用 VHD 创建 VM 时磁盘中包含的 OS 类型。可能的值包括：Windows、Linux。
OSDisk	指定有关虚拟机使用的操作系统磁盘的信息。有关磁盘的详细信息，请参阅关于 Azure 虚拟机的磁盘和 VHD。
SecurityEncryptionTypes	指定托管磁盘的 EncryptionType。它设置为 DiskWithVMGuestState，用于加密托管磁盘以及 VMGuestState blob、VMGuestStateOnly 以仅加密 VMGuestState blob，并将 NonPersistedTPM 设置为不保留 VMGuestState blob 中的固件状态。注意：只能为机密 VM 设置它。
StorageAccountTypes	指定托管磁盘的存储帐户类型。只能在创建规模集时设置托管 OS 磁盘存储帐户类型。注意：UltraSSD_LRS只能与数据磁盘一起使用。它不能与 OS 磁盘一起使用。 Standard_LRS使用标准 HDD。 StandardSSD_LRS使用标准 SSD。 Premium_LRS使用高级 SSD。 UltraSSD_LRS使用超级磁盘。 Premium_ZRS使用高级 SSD 区域冗余存储。 StandardSSD_ZRS使用标准 SSD 区域冗余存储。有关 Windows 虚拟机支持的磁盘的详细信息，请参阅 https://docs.microsoft.com/azure/virtual-machines/windows/disks-types，对于 Linux 虚拟机，请参阅 https://docs.microsoft.com/azure/virtual-machines/linux/disks-types
StorageProfile	指定虚拟机磁盘的存储设置。
SubResource
VirtualHardDisk	描述磁盘的 URI。
VMDiskSecurityProfile	指定托管磁盘的安全配置文件设置。注意：只能为机密 VM 设置它。

ApiEntityReference

Object

API 实体引用。

名称	类型	说明
id	string	/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... 形式的 ARM 资源 ID

ApiError

Object

Api 错误。

名称	类型	说明
code	string	错误代码。
details	ApiErrorBase[]	API 错误详细信息
innererror	InnerError	Api 内部错误
message	string	错误消息。
target	string	特定错误的目标。

ApiErrorBase

Object

Api 错误基数。

名称	类型	说明
code	string	错误代码。
message	string	错误消息。
target	string	特定错误的目标。

AttachDetachDataDisksRequest

Object

指定用于附加和分离托管数据磁盘列表的输入。

名称	类型	说明
dataDisksToAttach	DataDisksToAttach[]	要附加的托管数据磁盘的列表。
dataDisksToDetach	DataDisksToDetach[]	要分离的托管数据磁盘列表。

CachingTypes

枚举

指定缓存要求。可能的值为： None、ReadOnly、ReadWrite。 默认值为： Standard storage 的 None。高级存储的 ReadOnly

值	说明
None
ReadOnly
ReadWrite

CloudError

Object

来自计算服务的错误响应。

名称	类型	说明
error	ApiError	Api 错误。

DataDisk

Object

描述数据磁盘。

名称	类型	说明
caching	CachingTypes	指定缓存要求。可能的值为：None、ReadOnly、ReadWrite。默认行为为：标准存储 None。高级存储的 ReadOnly。
createOption	DiskCreateOptionTypes	指定应如何创建虚拟机磁盘。可能的值是附加：使用专用磁盘创建虚拟机时，将使用此值。 FromImage：使用映像创建虚拟机数据磁盘时使用此值。如果使用平台映像，还应使用上述 imageReference 元素。如果使用市场映像，还应使用前面所述的计划元素。空：创建空数据磁盘时使用此值。复制：此值用于从快照或其他磁盘创建数据磁盘。还原：此值用于从磁盘还原点创建数据磁盘。
deleteOption	DiskDeleteOptionTypes	指定在删除 VM 时是否应删除或分离数据磁盘。可能的值为：Delete。如果使用此值，则会在删除 VM 时删除数据磁盘。分离。如果使用此值，则在删除 VM 后保留数据磁盘。默认值设置为 Detach。
detachOption	DiskDetachOptionTypes	指定要在分离磁盘时使用的分离行为，或者已在从虚拟机分离过程中使用。支持的值：ForceDetach。 detachOption：ForceDetach 仅适用于托管数据磁盘。如果以前由于虚拟机意外故障而未完成数据磁盘的分离尝试，并且磁盘仍未释放，则使用强制分离作为最后手段选项从 VM 强行分离磁盘。使用此分离行为时，可能不会刷新所有写入。此功能仍处于预览阶段。若要强制分离数据磁盘更新到BeDetached 到“true”，以及设置 detachOption：“ForceDetach”。
diskIOPSReadWrite	integer (int64)	指定存储AccountType UltraSSD_LRS时托管磁盘的 Read-Write IOPS。仅针对 VirtualMachine ScaleSet VM 磁盘返回。只能通过对 VirtualMachine 规模集的更新进行更新。
diskMBpsReadWrite	integer (int64)	UltraSSD_LRS StorageAccountType 时，指定托管磁盘的带宽（以 MB/秒为单位）。仅针对 VirtualMachine ScaleSet VM 磁盘返回。只能通过对 VirtualMachine 规模集的更新进行更新。
diskSizeGB	integer (int32)	指定空数据磁盘的大小（以 GB 为单位）。此元素可用于覆盖虚拟机映像中的磁盘大小。属性“diskSizeGB”是磁盘的字节数 x 1024^3，该值不能大于 1023。
image	VirtualHardDisk	源用户映像虚拟硬盘。在附加到虚拟机之前，将复制虚拟硬盘。如果提供了 SourceImage，则目标虚拟硬盘驱动器不得存在。
lun	integer (int32)	指定数据磁盘的逻辑单元号。此值用于标识 VM 中的数据磁盘，因此对于附加到 VM 的每个数据磁盘必须是唯一的。
managedDisk	ManagedDiskParameters	托管磁盘参数。
name	string	磁盘名称。
sourceResource	ApiEntityReference	源资源标识符。它可以是用于创建磁盘的快照或磁盘还原点。
toBeDetached	boolean	指定数据磁盘是否正在从 VirtualMachine/VirtualMachineScaleset 分离
vhd	VirtualHardDisk	虚拟硬盘。
writeAcceleratorEnabled	boolean	指定是应在磁盘上启用或禁用 writeAccelerator。

DataDisksToAttach

Object

描述要附加的数据磁盘。

名称	类型	说明
caching	CachingTypes	指定缓存要求。可能的值为：None、ReadOnly、ReadWrite。默认行为为：标准存储 None。高级存储的 ReadOnly。
deleteOption	DiskDeleteOptionTypes	指定在删除 VM 时是否应删除或分离数据磁盘。可能的值为：Delete。如果使用此值，则会在删除 VM 时删除数据磁盘。分离。如果使用此值，则在删除 VM 后保留数据磁盘。默认值设置为 Detach。
diskEncryptionSet	DiskEncryptionSetParameters	指定托管磁盘的客户托管磁盘加密集资源 ID。
diskId	string	托管数据磁盘的 ID。
lun	integer (int32)	数据磁盘的逻辑单元号。此值用于标识 VM 中的数据磁盘，因此对于附加到 VM 的每个数据磁盘必须是唯一的。如果未指定，则会自动分配 lun。
writeAcceleratorEnabled	boolean	指定是应在磁盘上启用或禁用 writeAccelerator。

DataDisksToDetach

Object

描述要分离的数据磁盘。

名称	类型	说明
detachOption	DiskDetachOptionTypes	支持的选项可用于从 VM 分离磁盘。有关更多详细信息，请参阅 DetachOption 对象参考。
diskId	string	托管数据磁盘的 ID。

DiffDiskOptions

枚举

指定操作系统磁盘的临时磁盘选项。

值	说明
Local

DiffDiskPlacement

枚举

指定操作系统磁盘的临时磁盘放置。用户可以在请求中使用此属性来选择用于临时 OS 磁盘预配的位置，例如缓存磁盘、资源磁盘或 nvme 磁盘空间。有关临时 OS 磁盘大小要求的详细信息，请参阅上的 https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements Windows VM 和 Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements的临时 OS 磁盘大小要求。 NvmeDisk 的最低 API 版本：2024-03-01。

值	说明
CacheDisk
ResourceDisk
NvmeDisk

DiffDiskSettings

Object

描述可为操作系统磁盘指定的临时磁盘设置的参数。 注意： 临时磁盘设置只能为托管磁盘指定。

名称	类型	说明
option	DiffDiskOptions	指定操作系统磁盘的临时磁盘设置。
placement	DiffDiskPlacement	指定操作系统磁盘的临时磁盘放置。可能的值为：CacheDisk、ResourceDisk、NvmeDisk。默认行为为：如果为 VM 大小配置了一个，则 CacheDisk;否则，ResourceDisk 或使用 NvmeDisk。请参阅 https://docs.microsoft.com/azure/virtual-machines/windows/sizes https://docs.microsoft.com/azure/virtual-machines/linux/sizes 上的 Windows VM 和 Linux VM 的 VM 大小文档，以检查哪些 VM 大小公开了缓存磁盘。 NvmeDisk 的最低 API 版本：2024-03-01。

DiskControllerTypes

枚举

指定为 VM 和 VirtualMachineScaleSet 配置的磁盘控制器类型。只有操作系统磁盘和 VM SKU 支持第 2 代（https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2）的虚拟机才支持此属性，请在响应区域的 Microsoft.Compute SKU API 包含 V2（https://docs.microsoft.com/rest/api/compute/resourceskus/list）时检查作为 VM SKU 功能的一部分返回的 HyperVGenerations 功能。有关支持的磁盘控制器类型的详细信息，请参阅 https://aka.ms/azure-diskcontrollertypes。

值	说明
SCSI
NVMe

DiskCreateOptionTypes

枚举

指定应如何创建虚拟机磁盘。可能的值是 附加： 使用专用磁盘创建虚拟机时，将使用此值。 FromImage： 使用映像创建虚拟机时使用此值。如果使用平台映像，还应使用上述 imageReference 元素。如果使用市场映像，还应使用前面所述的计划元素。空：创建空数据磁盘时使用此值。 复制： 此值用于从快照或其他磁盘创建数据磁盘。 还原： 此值用于从磁盘还原点创建数据磁盘。

值	说明
FromImage
Empty
Attach
Copy
Restore

DiskDeleteOptionTypes

枚举

指定删除 VM 时托管磁盘的行为，例如是删除还是分离托管磁盘。支持的值为：Delete。 如果使用此值，则会在删除 VM 时删除托管磁盘。 分离。 如果使用此值，则会在删除 VM 后保留托管磁盘。最低 API 版本：2021-03-01。

值	说明
Delete
Detach

DiskDetachOptionTypes

枚举

指定要在分离磁盘时使用的分离行为，或者已在从虚拟机分离过程中使用。支持的值为： ForceDetach。 detachOption： ForceDetach 仅适用于托管数据磁盘。如果以前由于虚拟机意外故障而未完成数据磁盘的分离尝试，并且磁盘仍未释放，则使用强制分离作为最后手段选项从 VM 强行分离磁盘。使用此分离行为时，可能不会刷新所有写入。 此功能仍处于预览阶段。若要强制分离数据磁盘更新到BeDetached 到“true”，以及设置 detachOption：“ForceDetach”。

值	说明
ForceDetach

DiskEncryptionSetParameters

Object

描述可为磁盘指定的客户托管磁盘加密集资源 ID 的参数。 注意： 只能为托管磁盘指定磁盘加密集资源 ID。有关详细信息，请参阅 https://aka.ms/mdssewithcmkoverview。

名称	类型	说明
id	string	资源 ID

DiskEncryptionSettings

Object

描述磁盘的加密设置

名称	类型	说明
diskEncryptionKey	KeyVaultSecretReference	指定磁盘加密密钥的位置，该密钥是 Key Vault 机密。
enabled	boolean	指定是否应在虚拟机上启用磁盘加密。
keyEncryptionKey	KeyVaultKeyReference	指定 Key Vault 中密钥加密密钥的位置。

ImageReference

Object

指定要使用的图像的信息。可以指定有关平台映像、市场映像或虚拟机映像的信息。若要使用平台映像、市场映像或虚拟机映像，但不在其他创建操作中使用，则需要此元素。注意：只能在创建规模集时设置映像引用发布者和产品/服务。

名称	类型	说明
communityGalleryImageId	string	为 vm 部署指定社区库映像唯一 ID。这可以从社区库映像 GET 调用中提取。
exactVersion	string	以十进制数字指定用于创建虚拟机的平台映像或市场映像的版本。仅当“version”字段中指定的值为“latest”时，此只读字段与“version”不同。
id	string	资源 ID
offer	string	指定用于创建虚拟机的平台映像或市场映像的产品/服务。
publisher	string	映像发布者。
sharedGalleryImageId	string	为 vm 部署指定共享库映像唯一 ID。这可以从共享库映像 GET 调用中提取。
sku	string	映像 SKU。
version	string	指定用于创建虚拟机的平台映像或市场映像的版本。允许的格式为 Major.Minor.Build 或“latest”。主要、次要和生成是十进制数。指定“latest”以在部署时使用可用映像的最新版本。即使使用“最新”，即使新版本可用，VM 映像也不会在部署后自动更新。请不要对库映像部署使用字段“version”，库映像应始终使用“id”字段进行部署，若要使用库映像的“latest”版本，只需在“id”字段中设置“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageName}”，而不输入版本。

InnerError

Object

内部错误详细信息。

名称	类型	说明
errordetail	string	内部错误消息或异常转储。
exceptiontype	string	异常类型。

KeyVaultKeyReference

Object

描述对 Key Vault 密钥的引用

名称	类型	说明
keyUrl	string	引用 Key Vault 中的密钥加密密钥的 URL。
sourceVault	SubResource	包含密钥的 Key Vault 的相对 URL。

KeyVaultSecretReference

Object

描述对 Key Vault 机密的引用

名称	类型	说明
secretUrl	string	引用 Key Vault 中的机密的 URL。
sourceVault	SubResource	包含机密的 Key Vault 的相对 URL。

ManagedDiskParameters

Object

托管磁盘的参数。

名称	类型	说明
diskEncryptionSet	DiskEncryptionSetParameters	指定托管磁盘的客户托管磁盘加密集资源 ID。
id	string	资源 ID
securityProfile	VMDiskSecurityProfile	指定托管磁盘的安全配置文件。
storageAccountType	StorageAccountTypes	指定托管磁盘的存储帐户类型。注意：UltraSSD_LRS只能与数据磁盘一起使用，它不能与 OS 磁盘一起使用。

OperatingSystemTypes

枚举

此属性允许指定从用户映像或专用 VHD 创建 VM 时磁盘中包含的 OS 类型。可能的值包括：Windows、Linux。

值	说明
Windows
Linux

OSDisk

Object

指定有关虚拟机使用的操作系统磁盘的信息。有关磁盘的详细信息，请参阅关于 Azure 虚拟机的磁盘和 VHD。

名称	类型	说明
caching	CachingTypes	指定缓存要求。可能的值为：None、ReadOnly、ReadWrite。默认行为为：标准存储 None。高级存储的 ReadOnly。
createOption	DiskCreateOptionTypes	指定应如何创建虚拟机磁盘。可能的值是附加：使用专用磁盘创建虚拟机时，将使用此值。 FromImage：使用映像创建虚拟机时使用此值。如果使用平台映像，还应使用上述 imageReference 元素。如果使用市场映像，还应使用前面所述的计划元素。
deleteOption	DiskDeleteOptionTypes	指定在删除 VM 时是否应删除或分离 OS 磁盘。可能的值为：Delete。如果使用此值，则删除 VM 时会删除 OS 磁盘。分离。如果使用此值，则会在删除 VM 后保留 os 磁盘。默认值设置为 Detach。对于临时 OS 磁盘，默认值设置为删除。用户无法更改临时 OS 磁盘的删除选项。
diffDiskSettings	DiffDiskSettings	指定虚拟机使用的操作系统磁盘的临时磁盘设置。
diskSizeGB	integer (int32)	指定空数据磁盘的大小（以 GB 为单位）。此元素可用于覆盖虚拟机映像中的磁盘大小。属性“diskSizeGB”是磁盘的字节数 x 1024^3，该值不能大于 1023。
encryptionSettings	DiskEncryptionSettings	指定 OS 磁盘的加密设置。最低 API 版本：2015-06-15。
image	VirtualHardDisk	源用户映像虚拟硬盘。在附加到虚拟机之前，将复制虚拟硬盘。如果提供了 SourceImage，则目标虚拟硬盘驱动器不得存在。
managedDisk	ManagedDiskParameters	托管磁盘参数。
name	string	磁盘名称。
osType	OperatingSystemTypes	此属性允许指定从用户映像或专用 VHD 创建 VM 时磁盘中包含的 OS 类型。可能的值包括：Windows、Linux。
vhd	VirtualHardDisk	虚拟硬盘。
writeAcceleratorEnabled	boolean	指定是应在磁盘上启用或禁用 writeAccelerator。

SecurityEncryptionTypes

枚举

指定托管磁盘的 EncryptionType。它设置为 DiskWithVMGuestState，用于加密托管磁盘以及 VMGuestState blob、VMGuestStateOnly 以仅加密 VMGuestState blob，并将 NonPersistedTPM 设置为不保留 VMGuestState blob 中的固件状态。 注意： 只能为机密 VM 设置它。

值	说明
VMGuestStateOnly
DiskWithVMGuestState
NonPersistedTPM

StorageAccountTypes

枚举

指定托管磁盘的存储帐户类型。只能在创建规模集时设置托管 OS 磁盘存储帐户类型。注意：UltraSSD_LRS只能与数据磁盘一起使用。它不能与 OS 磁盘一起使用。 Standard_LRS使用标准 HDD。 StandardSSD_LRS使用标准 SSD。 Premium_LRS使用高级 SSD。 UltraSSD_LRS使用超级磁盘。 Premium_ZRS使用高级 SSD 区域冗余存储。 StandardSSD_ZRS使用标准 SSD 区域冗余存储。有关 Windows 虚拟机支持的磁盘的详细信息，请参阅 https://docs.microsoft.com/azure/virtual-machines/windows/disks-types，对于 Linux 虚拟机，请参阅 https://docs.microsoft.com/azure/virtual-machines/linux/disks-types

值	说明
Standard_LRS
Premium_LRS
StandardSSD_LRS
UltraSSD_LRS
Premium_ZRS
StandardSSD_ZRS
PremiumV2_LRS

StorageProfile

Object

指定虚拟机磁盘的存储设置。

名称	类型	说明
alignRegionalDisksToVMZone	boolean	指定区域磁盘是否应对齐/移动到 VM 区域。这仅适用于放置属性集的 VM。请注意，此更改不可逆。最低 api 版本：2024-11-01。
dataDisks	DataDisk[]	指定用于向虚拟机添加数据磁盘的参数。有关磁盘的详细信息，请参阅关于 Azure 虚拟机的磁盘和 VHD。
diskControllerType	DiskControllerTypes	指定为 VM 配置的磁盘控制器类型。注意：如果未指定提供的虚拟机，则会根据指定的最低 API 版本中的操作系统磁盘和 VM 大小的功能，使用“hyperVGeneration”设置为 V2，此属性将设置为默认磁盘控制器类型。在更新 VM 控制器类型之前，需要解除分配 VM，除非在 VM 配置中更新 VM 大小，该配置隐式解除分配并重新分配 VM。最低 API 版本：2022-08-01。
imageReference	ImageReference	指定要使用的图像的信息。可以指定有关平台映像、市场映像或虚拟机映像的信息。若要使用平台映像、市场映像或虚拟机映像，但不在其他创建操作中使用，则需要此元素。
osDisk	OSDisk	指定有关虚拟机使用的操作系统磁盘的信息。有关磁盘的详细信息，请参阅关于 Azure 虚拟机的磁盘和 VHD。

SubResource

Object

名称	类型	说明
id	string	资源 ID

VirtualHardDisk

Object

描述磁盘的 URI。

名称	类型	说明
uri	string	指定虚拟硬盘的 URI。

VMDiskSecurityProfile

Object

指定托管磁盘的安全配置文件设置。 注意： 只能为机密 VM 设置它。

名称	类型	说明
diskEncryptionSet	DiskEncryptionSetParameters	指定用于客户托管密钥加密的 ConfidentialVM OS 磁盘和 VMGuest Blob 的托管磁盘的客户托管磁盘加密集资源 ID。
securityEncryptionType	SecurityEncryptionTypes	指定托管磁盘的 EncryptionType。它设置为 DiskWithVMGuestState，用于加密托管磁盘以及 VMGuestState blob、VMGuestStateOnly 以仅加密 VMGuestState blob，并将 NonPersistedTPM 设置为不保留 VMGuestState blob 中的固件状态。注意：只能为机密 VM 设置它。

通过

Virtual Machines - Attach Detach Data Disks

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

示例请求

示例响应

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

示例请求

示例响应

定义

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