Virtual Machines - Attach Detach Data Disks

參考

服務:: Compute

API 版本:: 2024-07-01

將數據磁碟連結至虛擬機或從虛擬機連結和中斷連結。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
vmName	path	True	string	虛擬機的名稱。
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	類型	Description
parameters	AttachDetachDataDisksRequest	提供給虛擬機上連結和中斷鏈接數據磁碟作業的參數。

回應

名稱	類型	Description
200 OK	StorageProfile	還行
202 Accepted		接受標題 Location: string
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

名稱

類型

Description

200 OK

StorageProfile

還行

202 Accepted

接受

標題

Location: string

Other Status Codes

CloudError

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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-07-01

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


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

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

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_attach_detach_data_disks_maximum_set_gen.py

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


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

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


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.json
if __name__ == "__main__":
    main()

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

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v6"
)

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

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

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

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

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.json
// this example is just showing the usage of "VirtualMachines_AttachDetachDataDisks" operation, for the dependent resources, they will have to be created separately.

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

// this example assumes you already have this VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "rgcompute";
string vmName = "aaaaaaaaaaaaaaaaaaaa";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

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

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

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

範例回覆

狀態碼:: 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-07-01

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


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

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

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_attach_detach_data_disks_minimum_set_gen.py

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


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

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


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.json
if __name__ == "__main__":
    main()

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

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v6"
)

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

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

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

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

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.json
// this example is just showing the usage of "VirtualMachines_AttachDetachDataDisks" operation, for the dependent resources, they will have to be created separately.

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

// this example assumes you already have this VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "rgcompute";
string vmName = "azure-vm";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

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

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

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

範例回覆

狀態碼:: 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

定義

名稱	Description
ApiEntityReference	來源資源標識碼。它可以是建立磁碟的快照集或磁碟還原點。
ApiError	Api 錯誤。
ApiErrorBase	API 錯誤基底。
AttachDetachDataDisksRequest	提供給虛擬機上連結和中斷鏈接數據磁碟作業的參數。
CachingTypes	指定快取需求。可能的值為：None、ReadOnly、ReadWrite。預設行為為：標準記憶體的 None。進階記憶體的 ReadOnly。
CloudError	來自計算服務的錯誤回應。
DataDisk	指定用來將數據磁碟新增至虛擬機的參數。如需磁碟的詳細資訊，請參閱關於 Azure 虛擬機器的磁碟和 VHD。
DataDisksToAttach	要連結的受控數據磁碟清單。
DataDisksToDetach	要中斷連結的受控數據磁碟清單。
DiffDiskOptions	指定作業系統磁碟的暫時磁碟設定。
DiffDiskPlacement	指定作業系統磁碟的暫時磁碟位置。可能的值為：CacheDisk、ResourceDisk、NvmeDisk。預設行為為：如果已針對 VM 大小設定，CacheDisk，否則會使用 ResourceDisk 或 NvmeDisk。請參閱 windows VM 在 https://docs.microsoft.com/azure/virtual-machines/windows/sizes 的 VM 大小檔，以及 https://docs.microsoft.com/azure/virtual-machines/linux/sizes Linux VM 的 VM 大小檔，以檢查哪些 VM 大小會公開快取磁碟。 NvmeDisk 的最低 API 版本：2024-03-01。
DiffDiskSettings	指定虛擬機所用作業系統磁碟的暫時磁碟設定。
DiskControllerTypes	指定為 VM 設定的磁碟控制器類型。注意：如果未指定提供的虛擬機建立時，此屬性會設定為預設磁碟控制器類型，而 'hyperVGeneration' 會根據指定之最低 API 版本之操作系統磁碟和 VM 大小的功能設定為 V2。您必須在更新 VM 控制器類型之前解除分配 VM，除非您在 VM 設定中更新 VM 大小，以隱含解除分配和重新配置 VM。 API 版本下限：2022-08-01。
DiskCreateOptionTypes	指定應如何建立虛擬機磁碟。可能的值為 Attach：當您使用特製化磁碟來建立虛擬機時，會使用此值。 FromImage：當您使用映射建立虛擬機時，會使用此值。如果您使用平臺映像，則也應該使用上述的 imageReference 元素。如果您使用市集映射，則也應該使用先前所述的 plan 元素。
DiskDeleteOptionTypes	指定 VM 刪除時應刪除或中斷連結 OS 磁碟。可能的值為：Delete。如果使用這個值，刪除 VM 時會刪除 OS 磁碟。分離。如果使用這個值，則會在刪除 VM 之後保留 os 磁碟。預設值設定為 Detach。針對暫時的 OS 磁碟，預設值會設定為 [刪除]。使用者無法變更暫時 OS 磁碟的刪除選項。
DiskDetachOptionTypes	指定卸離磁碟時所要使用的卸離行為，或已在從虛擬機中斷鏈接的過程中使用的行為。支援的值：ForceDetach。 detachOption：ForceDetach 僅適用於受控數據磁碟。如果先前的數據磁盤中斷鏈接嘗試未完成，因為虛擬機發生非預期的失敗，磁碟仍未釋放，則請使用強制卸離作為最後手段選項，強制中斷連結磁碟與 VM。使用這個卸離行為時，所有寫入可能都沒有排清。若要強制將數據磁碟更新強制卸離至『true』，以及設定 detachOption： 'ForceDetach'。
DiskEncryptionSetParameters	指定受控磁碟的客戶受控磁碟加密集資源標識符。
DiskEncryptionSettings	指定 OS 磁碟的加密設定。 API 版本下限：2015-06-15。
ImageReference	指定要使用之映像的相關信息。您可以指定平臺映像、市集映像或虛擬機映像的相關信息。當您想要使用平臺映像、市集映像或虛擬機映像，但未用於其他建立作業時，則需要此元素。
InnerError	內部錯誤詳細數據。
KeyVaultKeyReference	指定 Key Vault 中金鑰加密金鑰的位置。
KeyVaultSecretReference	指定磁碟加密密鑰的位置，也就是 Key Vault 秘密。
ManagedDiskParameters	受控磁碟參數。
OperatingSystemTypes	操作系統類型。
OSDisk	指定虛擬機所使用的作業系統磁碟相關信息。如需磁碟的詳細資訊，請參閱關於 Azure 虛擬機器的磁碟和 VHD。
securityEncryptionTypes	指定受控磁碟的 EncryptionType。它會設定為 DiskWithVMGuestState 來加密受控磁碟以及 VMGuestState Blob、VMGuestStateOnly，以便只加密 VMGuestState Blob，以及 NonPersistedTPM 以在 VMGuestState blob 中保存韌體狀態。注意：只能設定機密 VM。
StorageAccountTypes	指定受控磁碟的記憶體帳戶類型。注意：UltraSSD_LRS只能與數據磁碟搭配使用，因此無法與OS磁碟搭配使用。
StorageProfile	指定虛擬機磁碟的記憶體設定。
SubResource
VirtualHardDisk	虛擬硬碟。
VMDiskSecurityProfile	指定受控磁碟的安全性配置檔。

ApiEntityReference

來源資源標識碼。它可以是建立磁碟的快照集或磁碟還原點。

名稱	類型	Description
id	string	以 /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... 格式的 ARM 資源標識符

ApiError

Api 錯誤。

名稱	類型	Description
code	string	錯誤碼。
details	ApiErrorBase[]	Api 錯誤詳細數據
innererror	InnerError	Api 內部錯誤
message	string	錯誤訊息。
target	string	特定錯誤的目標。

ApiErrorBase

API 錯誤基底。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息。
target	string	特定錯誤的目標。

AttachDetachDataDisksRequest

提供給虛擬機上連結和中斷鏈接數據磁碟作業的參數。

名稱	類型	Description
dataDisksToAttach	DataDisksToAttach[]	要連結的受控數據磁碟清單。
dataDisksToDetach	DataDisksToDetach[]	要中斷連結的受控數據磁碟清單。

CachingTypes

指定快取需求。可能的值為：None、ReadOnly、ReadWrite。 預設行為為：標準記憶體的 None。進階記憶體的 ReadOnly。

名稱	類型	Description
None	string
ReadOnly	string
ReadWrite	string

CloudError

來自計算服務的錯誤回應。

名稱	類型	Description
error	ApiError	Api 錯誤。

DataDisk

指定用來將數據磁碟新增至虛擬機的參數。如需磁碟的詳細資訊，請參閱關於 Azure 虛擬機器的磁碟和 VHD。

名稱	類型	Description
caching	CachingTypes	指定快取需求。可能的值為：None、ReadOnly、ReadWrite。預設行為為：標準記憶體的 None。進階記憶體的 ReadOnly。
createOption	DiskCreateOptionTypes	指定應如何建立虛擬機磁碟。可能的值為 Attach：當您使用特製化磁碟來建立虛擬機時，會使用此值。 FromImage：當您使用映像建立虛擬機數據磁碟時，會使用此值此值。如果您使用平臺映像，則也應該使用上述的 imageReference 元素。如果您使用市集映射，則也應該使用先前所述的 plan 元素。空白：建立空白數據磁碟時會使用此值。複製：此值可用來從快照集或其他磁碟建立數據磁碟。還原：此值可用來從磁碟還原點建立數據磁碟。
deleteOption	DiskDeleteOptionTypes	指定在 VM 刪除時應該刪除或中斷連結資料磁碟。可能的值為：Delete。如果使用此值，刪除 VM 時會刪除資料磁碟。分離。如果使用此值，則會在刪除 VM 之後保留資料磁碟。預設值設定為 Detach。
detachOption	DiskDetachOptionTypes	指定卸離磁碟時所要使用的卸離行為，或已在從虛擬機中斷鏈接的過程中使用的行為。支援的值：ForceDetach。 detachOption：ForceDetach 僅適用於受控數據磁碟。如果先前的數據磁盤中斷鏈接嘗試未完成，因為虛擬機發生非預期的失敗，磁碟仍未釋放，則請使用強制卸離作為最後手段選項，強制中斷連結磁碟與 VM。使用這個卸離行為時，所有寫入可能都沒有排清。若要強制將數據磁碟更新強制卸離至『true』，以及設定 detachOption： 'ForceDetach'。
diskIOPSReadWrite	integer	指定 StorageAccountType UltraSSD_LRS時受控磁碟的 Read-Write IOPS。僅針對 VirtualMachine ScaleSet VM 磁碟傳回。只能透過 VirtualMachine 擴展集的更新來更新。
diskMBpsReadWrite	integer	指定 StorageAccountType UltraSSD_LRS時，受控磁碟每秒 MB 的頻寬。僅針對 VirtualMachine ScaleSet VM 磁碟傳回。只能透過 VirtualMachine 擴展集的更新來更新。
diskSizeGB	integer	指定以 GB 為單位的空白資料磁碟大小。這個元素可用來覆寫虛擬機映像中的磁碟大小。屬性 'diskSizeGB' 是磁碟的位元組 x 1024^3，值不能大於 1023。
image	VirtualHardDisk	來源使用者映像虛擬硬碟。在連接至虛擬機之前，將會先複製虛擬硬碟。如果提供SourceImage，則目的地虛擬硬碟不得存在。
lun	integer	指定數據磁碟的邏輯單元編號。這個值是用來識別 VM 內的數據磁碟，因此對於連結至 VM 的每個數據磁碟而言都必須是唯一的。
managedDisk	ManagedDiskParameters	受控磁碟參數。
name	string	磁碟名稱。
sourceResource	ApiEntityReference	來源資源標識碼。它可以是建立磁碟的快照集或磁碟還原點。
toBeDetached	boolean	指定數據磁碟是否正在從 VirtualMachine/VirtualMachineScaleset 中斷連結
vhd	VirtualHardDisk	虛擬硬碟。
writeAcceleratorEnabled	boolean	指定是否應該在磁碟上啟用或停用 writeAccelerator。

DataDisksToAttach

要連結的受控數據磁碟清單。

名稱	類型	Description
caching	CachingTypes	指定快取需求。可能的值為：None、ReadOnly、ReadWrite。預設行為為：標準記憶體的 None。進階記憶體的 ReadOnly。
deleteOption	DiskDeleteOptionTypes	指定在 VM 刪除時應該刪除或中斷連結資料磁碟。可能的值為：Delete。如果使用此值，刪除 VM 時會刪除資料磁碟。分離。如果使用此值，則會在刪除 VM 之後保留資料磁碟。預設值設定為 Detach。
diskEncryptionSet	DiskEncryptionSetParameters	指定受控磁碟的客戶受控磁碟加密集資源標識符。
diskId	string	受控數據磁碟的標識碼。
lun	integer	數據磁碟的邏輯單元編號。這個值是用來識別 VM 內的數據磁碟，因此對於連結至 VM 的每個數據磁碟而言都必須是唯一的。如果未指定，則會自動指派 lun。
writeAcceleratorEnabled	boolean	指定是否應該在磁碟上啟用或停用 writeAccelerator。

DataDisksToDetach

要中斷連結的受控數據磁碟清單。

名稱	類型	Description
detachOption	DiskDetachOptionTypes	可從 VM 中斷連結磁碟的支援選項。如需詳細資訊，請參閱DetachOption對象參考。
diskId	string	受控數據磁碟的標識碼。

DiffDiskOptions

指定作業系統磁碟的暫時磁碟設定。

名稱	類型	Description
Local	string

DiffDiskPlacement

指定作業系統磁碟的暫時磁碟位置。可能的值為：CacheDisk、ResourceDisk、NvmeDisk。 預設行為為：如果已針對 VM 大小設定，CacheDisk，否則會使用 ResourceDisk 或 NvmeDisk。請參閱 windows VM 在 https://docs.microsoft.com/azure/virtual-machines/windows/sizes 的 VM 大小檔，以及 https://docs.microsoft.com/azure/virtual-machines/linux/sizes Linux VM 的 VM 大小檔，以檢查哪些 VM 大小會公開快取磁碟。 NvmeDisk 的最低 API 版本：2024-03-01。

名稱	類型	Description
CacheDisk	string
NvmeDisk	string
ResourceDisk	string

DiffDiskSettings

指定虛擬機所用作業系統磁碟的暫時磁碟設定。

名稱	類型	Description
option	DiffDiskOptions	指定作業系統磁碟的暫時磁碟設定。
placement	DiffDiskPlacement	指定作業系統磁碟的暫時磁碟位置。可能的值為：CacheDisk、ResourceDisk、NvmeDisk。預設行為為：如果已針對 VM 大小設定，CacheDisk，否則會使用 ResourceDisk 或 NvmeDisk。請參閱 windows VM 在 https://docs.microsoft.com/azure/virtual-machines/windows/sizes 的 VM 大小檔，以及 https://docs.microsoft.com/azure/virtual-machines/linux/sizes Linux VM 的 VM 大小檔，以檢查哪些 VM 大小會公開快取磁碟。 NvmeDisk 的最低 API 版本：2024-03-01。

DiskControllerTypes

指定為 VM 設定的磁碟控制器類型。注意：如果未指定提供的虛擬機建立時，此屬性會設定為預設磁碟控制器類型，而 'hyperVGeneration' 會根據指定之最低 API 版本之操作系統磁碟和 VM 大小的功能設定為 V2。您必須在更新 VM 控制器類型之前解除分配 VM，除非您在 VM 設定中更新 VM 大小，以隱含解除分配和重新配置 VM。 API 版本下限：2022-08-01。

名稱	類型	Description
NVMe	string
SCSI	string

DiskCreateOptionTypes

指定應如何建立虛擬機磁碟。可能的值為 Attach： 當您使用特製化磁碟來建立虛擬機時，會使用此值。 FromImage： 當您使用映射建立虛擬機時，會使用此值。如果您使用平臺映像，則也應該使用上述的 imageReference 元素。如果您使用市集映射，則也應該使用先前所述的 plan 元素。

名稱	類型	Description
Attach	string
Copy	string
Empty	string
FromImage	string
Restore	string

DiskDeleteOptionTypes

指定 VM 刪除時應刪除或中斷連結 OS 磁碟。可能的值為：Delete。 如果使用這個值，刪除 VM 時會刪除 OS 磁碟。 分離。 如果使用這個值，則會在刪除 VM 之後保留 os 磁碟。預設值設定為 Detach。針對暫時的 OS 磁碟，預設值會設定為 [刪除]。使用者無法變更暫時 OS 磁碟的刪除選項。

名稱	類型	Description
Delete	string
Detach	string

DiskDetachOptionTypes

指定卸離磁碟時所要使用的卸離行為，或已在從虛擬機中斷鏈接的過程中使用的行為。支援的值：ForceDetach。 detachOption：ForceDetach 僅適用於受控數據磁碟。如果先前的數據磁盤中斷鏈接嘗試未完成，因為虛擬機發生非預期的失敗，磁碟仍未釋放，則請使用強制卸離作為最後手段選項，強制中斷連結磁碟與 VM。使用這個卸離行為時，所有寫入可能都沒有排清。若要強制將數據磁碟更新強制卸離至『true』，以及設定 detachOption： 'ForceDetach'。

名稱	類型	Description
ForceDetach	string

DiskEncryptionSetParameters

指定受控磁碟的客戶受控磁碟加密集資源標識符。

名稱	類型	Description
id	string	資源標識碼

DiskEncryptionSettings

指定 OS 磁碟的加密設定。 API 版本下限：2015-06-15。

名稱	類型	Description
diskEncryptionKey	KeyVaultSecretReference	指定磁碟加密密鑰的位置，也就是 Key Vault 秘密。
enabled	boolean	指定是否應在虛擬機上啟用磁碟加密。
keyEncryptionKey	KeyVaultKeyReference	指定 Key Vault 中金鑰加密金鑰的位置。

ImageReference

指定要使用之映像的相關信息。您可以指定平臺映像、市集映像或虛擬機映像的相關信息。當您想要使用平臺映像、市集映像或虛擬機映像，但未用於其他建立作業時，則需要此元素。

名稱	類型	Description
communityGalleryImageId	string	指定 vm 部署的社群資源庫映像唯一標識碼。這可以從社群資源庫映像 GET 呼叫擷取。
exactVersion	string	以十進位數指定用來建立虛擬機的平臺映像或市集映像版本。這個只讀欄位與 'version' 不同，只有在 'version' 字段中指定的值為 'latest' 時。
id	string	資源標識碼
offer	string	指定用來建立虛擬機的平臺映像或市集映像供應專案。
publisher	string	映像發行者。
sharedGalleryImageId	string	指定 vm 部署的共享資源庫映像唯一標識碼。這可以從共用資源庫映像 GET 呼叫擷取。
sku	string	映像 SKU。
version	string	指定用來建立虛擬機的平臺映像或市集映像版本。允許的格式為 Major.Minor.Build 或 'latest'。主要、次要和組建是十進位數。指定 'latest' 以在部署時間使用可用映像的最新版本。即使您使用「最新」，即使有新版本可用，VM 映像也不會在部署時間之後自動更新。請勿使用欄位 'version' 進行資源庫映射部署，資源庫映射應一律使用 'id' 字段進行部署，若要使用資源庫映射的 'latest' 版本，只要設定 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageName}' 字段，即可不使用版本輸入。

InnerError

內部錯誤詳細數據。

名稱	類型	Description
errordetail	string	內部錯誤訊息或例外狀況傾印。
exceptiontype	string	例外狀況類型。

KeyVaultKeyReference

指定 Key Vault 中金鑰加密金鑰的位置。

名稱	類型	Description
keyUrl	string	參考 Key Vault 中金鑰加密金鑰的 URL。
sourceVault	SubResource	包含金鑰之 Key Vault 的相對 URL。

KeyVaultSecretReference

指定磁碟加密密鑰的位置，也就是 Key Vault 秘密。

名稱	類型	Description
secretUrl	string	參考 Key Vault 中秘密的 URL。
sourceVault	SubResource	包含秘密之 Key Vault 的相對 URL。

ManagedDiskParameters

受控磁碟參數。

名稱	類型	Description
diskEncryptionSet	DiskEncryptionSetParameters	指定受控磁碟的客戶受控磁碟加密集資源標識符。
id	string	資源標識碼
securityProfile	VMDiskSecurityProfile	指定受控磁碟的安全性配置檔。
storageAccountType	StorageAccountTypes	指定受控磁碟的記憶體帳戶類型。注意：UltraSSD_LRS只能與數據磁碟搭配使用，因此無法與OS磁碟搭配使用。

OperatingSystemTypes

操作系統類型。

名稱	類型	Description
Linux	string
Windows	string

OSDisk

指定虛擬機所使用的作業系統磁碟相關信息。如需磁碟的詳細資訊，請參閱關於 Azure 虛擬機器的磁碟和 VHD。

名稱	類型	Description
caching	CachingTypes	指定快取需求。可能的值為：None、ReadOnly、ReadWrite。預設行為為：標準記憶體的 None。進階記憶體的 ReadOnly。
createOption	DiskCreateOptionTypes	指定應如何建立虛擬機磁碟。可能的值為 Attach：當您使用特製化磁碟來建立虛擬機時，會使用此值。 FromImage：當您使用映射建立虛擬機時，會使用此值。如果您使用平臺映像，則也應該使用上述的 imageReference 元素。如果您使用市集映射，則也應該使用先前所述的 plan 元素。
deleteOption	DiskDeleteOptionTypes	指定 VM 刪除時應刪除或中斷連結 OS 磁碟。可能的值為：Delete。如果使用這個值，刪除 VM 時會刪除 OS 磁碟。分離。如果使用這個值，則會在刪除 VM 之後保留 os 磁碟。預設值設定為 Detach。針對暫時的 OS 磁碟，預設值會設定為 [刪除]。使用者無法變更暫時 OS 磁碟的刪除選項。
diffDiskSettings	DiffDiskSettings	指定虛擬機所用作業系統磁碟的暫時磁碟設定。
diskSizeGB	integer	指定以 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。

名稱	類型	Description
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

StorageAccountTypes

指定受控磁碟的記憶體帳戶類型。注意：UltraSSD_LRS只能與數據磁碟搭配使用，因此無法與OS磁碟搭配使用。

名稱	類型	Description
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

StorageProfile

指定虛擬機磁碟的記憶體設定。

名稱	類型	Description
dataDisks	DataDisk[]	指定用來將數據磁碟新增至虛擬機的參數。如需磁碟的詳細資訊，請參閱關於 Azure 虛擬機器的磁碟和 VHD。
diskControllerType	DiskControllerTypes	指定為 VM 設定的磁碟控制器類型。注意：如果未指定提供的虛擬機建立時，此屬性會設定為預設磁碟控制器類型，而 'hyperVGeneration' 會根據指定之最低 API 版本之操作系統磁碟和 VM 大小的功能設定為 V2。您必須在更新 VM 控制器類型之前解除分配 VM，除非您在 VM 設定中更新 VM 大小，以隱含解除分配和重新配置 VM。 API 版本下限：2022-08-01。
imageReference	ImageReference	指定要使用之映像的相關信息。您可以指定平臺映像、市集映像或虛擬機映像的相關信息。當您想要使用平臺映像、市集映像或虛擬機映像，但未用於其他建立作業時，則需要此元素。
osDisk	OSDisk	指定虛擬機所使用的作業系統磁碟相關信息。如需磁碟的詳細資訊，請參閱關於 Azure 虛擬機器的磁碟和 VHD。

SubResource

名稱	類型	Description
id	string	資源標識碼

VirtualHardDisk

虛擬硬碟。

名稱	類型	Description
uri	string	指定虛擬硬碟的 URI。

VMDiskSecurityProfile

指定受控磁碟的安全性配置檔。

名稱	類型	Description
diskEncryptionSet	DiskEncryptionSetParameters	針對客戶受控密鑰加密的機密VM OS 磁碟和 VMGuest Blob 所使用的受控磁碟，指定客戶受控磁碟加密集資源識別碼。
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

其他資源