Virtual Machines - Attach Detach Data Disks

リファレンス

Service:: Compute

API Version:: 2024-03-01

仮想マシンとの間でデータディスクをアタッチおよびデタッチします。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
vmName	path	True	string	仮想マシンの名前。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	型	説明
parameters	AttachDetachDataDisksRequest	仮想マシンでのデータディスクのアタッチおよびデタッチ操作に指定されたパラメーター。

応答

名前	型	説明
200 OK	StorageProfile	OK
202 Accepted		同意 Headers Location: string
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

StorageProfile

202 Accepted

同意

Headers

Location: string

Other Status Codes

CloudError

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

Sample Request

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

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

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

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

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


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

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


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

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

package armcompute_test

import (
	"context"
	"log"

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

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

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

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

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

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

Sample Response

Status code:: 200

location: https://foo.com/operationstatus

Response Body

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

Status code:: 202

location: https://foo.com/operationstatus

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

Sample Request

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

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

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

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

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


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

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


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

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

package armcompute_test

import (
	"context"
	"log"

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

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

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

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

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

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

Sample Response

Status code:: 200

location: https://foo.com/operationstatus

Response Body

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

Status code:: 202

location: https://foo.com/operationstatus

定義

名前	説明
ApiEntityReference	ソースリソース識別子。ディスクの作成元となるスナップショットまたはディスク復元ポイントを指定できます。
ApiError	API エラー。
ApiErrorBase	API エラーベース。
AttachDetachDataDisksRequest	仮想マシンでのデータディスクのアタッチおよびデタッチ操作に指定されたパラメーター。
CachingTypes	キャッシュの要件を指定します。使用できる値は、 None、ReadOnly、ReadWrite です。既定の動作は、標準ストレージの場合は [なし] です。Premium Storage の ReadOnly。
CloudError	コンピューティングサービスからのエラー応答。
DataDisk	仮想マシンにデータディスクを追加するために使用されるパラメーターを指定します。ディスクの詳細については、「 Azure 仮想マシンのディスクと VHD について」を参照してください。
DataDisksToAttach	アタッチするマネージドデータディスクの一覧。
DataDisksToDetach	デタッチするマネージドデータディスクの一覧。
DiffDiskOptions	オペレーティングシステムディスクのエフェメラルディスク設定を指定します。
DiffDiskPlacement	オペレーティングシステムディスクのエフェメラルディスクの配置を指定します。使用できる値は、 CacheDisk、ResourceDisk、NvmeDisk です。既定の動作は、VM サイズ用に構成されている場合は CacheDisk 、それ以外の場合は ResourceDisk または NvmeDisk が使用されます。キャッシュディスクを公開する VM サイズをチェックするには、Windows VM と https://docs.microsoft.com/azure/virtual-machines/windows/sizes Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/sizes の VM サイズに関するドキュメントを参照してください。 NvmeDisk の最小 api-version: 2024-03-01。
DiffDiskSettings	仮想マシンで使用されるオペレーティングシステムディスクのエフェメラルディスク設定を指定します。
DiskControllerTypes	VM 用に構成されたディスクコントローラーの種類を指定します。メモ：指定されていない場合、このプロパティは、指定された最小 API バージョンのオペレーティングシステムディスクと VM サイズの機能に基づいて、"hyperVGeneration" が V2 に設定された状態で作成される仮想マシンが既定のディスクコントローラーの種類に設定されます。 VM の割り当てを暗黙的に解除して再割り当てする VM 構成で VM サイズを更新しない限り、ディスクコントローラーの種類を更新する前に VM の割り当てを解除する必要があります。最小 api-version: 2022-08-01。
DiskCreateOptionTypes	仮想マシンディスクの作成方法を指定します。指定できる値は [アタッチ] です。この値は、特殊化されたディスクを使用して仮想マシンを作成するときに使用されます。 FromImage: この値は、イメージを使用して仮想マシンを作成するときに使用されます。プラットフォームイメージを使用している場合は、上記の imageReference 要素も使用する必要があります。マーケットプレースイメージを使用している場合は、前に説明した plan 要素も使用する必要があります。
DiskDeleteOptionTypes	VM の削除時に OS ディスクを削除するかデタッチするかを指定します。使用できる値は、Delete です。この値を使用すると、VM が削除されると OS ディスクが削除されます。デタッチ。この値を使用すると、VM が削除された後も os ディスクが保持されます。既定値は [デタッチ] に設定されています。エフェメラル OS ディスクの場合、既定値は Delete に設定されます。ユーザーは、エフェメラル OS ディスクの削除オプションを変更できません。
DiskDetachOptionTypes	ディスクのデタッチ中に使用するデタッチ動作、または仮想マシンからのデタッチ処理中のデタッチ動作を指定します。サポートされている値: ForceDetach。 detachOption: ForceDetach は、マネージドデータディスクにのみ適用されます。仮想マシンからの予期しない障害が原因でデータディスクの以前のデタッチ試行が完了せず、ディスクがまだ解放されていない場合は、最後の手段として強制デタッチを使用して、VM からディスクを強制的にデタッチします。このデタッチ動作を使用する場合、すべての書き込みがフラッシュされていない可能性があります。この機能は引き続きプレビューモードであり、VirtualMachineScaleSet ではサポートされていません。データディスクを強制的にデタッチするには、detachOption: 'ForceDetach' の設定と共にBeDetached を 'true' に更新します。
DiskEncryptionSetParameters	マネージドディスクのカスタマーマネージドディスク暗号化セットリソース ID を指定します。
DiskEncryptionSettings	OS ディスクの暗号化設定を指定します。最小 api-version: 2015-06-15。
ImageReference	使用するイメージに関する情報を指定します。プラットフォームイメージ、マーケットプレースイメージ、または仮想マシンイメージに関する情報を指定できます。この要素は、プラットフォームイメージ、マーケットプレースイメージ、または仮想マシンイメージを使用する場合に必要ですが、他の作成操作では使用されません。
InnerError	内部エラーの詳細。
KeyVaultKeyReference	Key Vault内のキー暗号化キーの場所を指定します。
KeyVaultSecretReference	Key Vault シークレットであるディスク暗号化キーの場所を指定します。
ManagedDiskParameters	マネージドディスクのパラメーター。
OperatingSystemTypes	オペレーティングシステムの種類。
OSDisk	仮想マシンで使用されるオペレーティングシステムディスクに関する情報を指定します。ディスクの詳細については、「 Azure 仮想マシンのディスクと VHD について」を参照してください。
securityEncryptionTypes	マネージドディスクの EncryptionType を指定します。 VMGuestState BLOB と共にマネージドディスクを暗号化する場合は DiskWithVMGuestState、VMGuestState BLOB のみの暗号化では VMGuestStateOnly、VMGuestState BLOB にファームウェア状態を保持しない場合は NonPersistedTPM に設定されます。メモ：これは、機密 VM にのみ設定できます。
StorageAccountTypes	マネージドディスクのストレージアカウントの種類を指定します。注: UltraSSD_LRSはデータディスクでのみ使用できますが、OS ディスクでは使用できません。
StorageProfile	仮想マシンのストレージ設定を指定します。
SubResource
VirtualHardDisk	仮想ハードディスク。
VMDiskSecurityProfile	マネージドディスクのセキュリティプロファイルを指定します。

ApiEntityReference

ソースリソース識別子。ディスクの作成元となるスナップショットまたはディスク復元ポイントを指定できます。

名前	型	説明
id	string	/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..の形式の ARM リソース ID。

ApiError

API エラー。

名前	型	説明
code	string	エラーコード。
details	ApiErrorBase[]	Api エラーの詳細
innererror	InnerError	Api の内部エラー
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

ApiErrorBase

API エラーベース。

名前	型	説明
code	string	エラーコード。
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

AttachDetachDataDisksRequest

仮想マシンでのデータディスクのアタッチおよびデタッチ操作に指定されたパラメーター。

名前	型	説明
dataDisksToAttach	DataDisksToAttach[]	アタッチするマネージドデータディスクの一覧。
dataDisksToDetach	DataDisksToDetach[]	デタッチするマネージドデータディスクの一覧。

CachingTypes

キャッシュの要件を指定します。使用できる値は、 None、ReadOnly、ReadWrite です。 既定の動作は、 標準ストレージの場合は [なし] です。Premium Storage の ReadOnly。

名前	型	説明
None	string
ReadOnly	string
ReadWrite	string

CloudError

コンピューティングサービスからのエラー応答。

名前	型	説明
error	ApiError	API エラー。

DataDisk

仮想マシンにデータディスクを追加するために使用されるパラメーターを指定します。ディスクの詳細については、「 Azure 仮想マシンのディスクと VHD について」を参照してください。

名前	型	説明
caching	CachingTypes	キャッシュの要件を指定します。使用できる値は、 None、ReadOnly、ReadWrite です。既定の動作は、 Standard Storage の場合は None です。Premium Storage の ReadOnly。
createOption	DiskCreateOptionTypes	仮想マシンディスクの作成方法を指定します。指定できる値は [アタッチ] です。この値は、特殊化されたディスクを使用して仮想マシンを作成するときに使用されます。 FromImage: この値は、イメージを使用して仮想マシンのデータディスクを作成するときに使用されます。プラットフォームイメージを使用している場合は、上記の imageReference 要素も使用する必要があります。マーケットプレースイメージを使用している場合は、前に説明した plan 要素も使用する必要があります。空：この値は、空のデータディスクを作成するときに使用されます。コピー：この値は、スナップショットまたは別のディスクからデータディスクを作成するために使用されます。復元：この値は、ディスク復元ポイントからデータディスクを作成するために使用されます。
deleteOption	DiskDeleteOptionTypes	VM の削除時にデータディスクを削除するかデタッチするかを指定します。指定できる値は、Delete です。この値を使用すると、VM の削除時にデータディスクが削除されます。デタッチ。この値を使用すると、VM が削除された後もデータディスクが保持されます。既定値は [デタッチ] に設定されています。
detachOption	DiskDetachOptionTypes	ディスクのデタッチ中に使用するデタッチ動作、または仮想マシンからのデタッチ処理中のデタッチ動作を指定します。サポートされる値: ForceDetach。 detachOption: ForceDetach はマネージドデータディスクにのみ適用されます。仮想マシンからの予期しない障害が原因でデータディスクの以前のデタッチ試行が完了せず、ディスクがまだ解放されていない場合は、最後の手段として強制デタッチを使用して、VM からディスクを強制的にデタッチします。このデタッチ動作を使用する場合、すべての書き込みがフラッシュされていない可能性があります。この機能はまだプレビューモードであり、VirtualMachineScaleSet ではサポートされていません。 detachOption: 'ForceDetach' の設定と共に、データディスクを強制的にBeDetached に 'true' に更新します。
diskIOPSReadWrite	integer	StorageAccountType がUltraSSD_LRSされている場合のマネージドディスクの Read-Write IOPS を指定します。 VirtualMachine ScaleSet VM ディスクの場合にのみ返されます。 VirtualMachine スケールセットの更新によってのみ更新できます。
diskMBpsReadWrite	integer	StorageAccountType がUltraSSD_LRS場合のマネージドディスクの帯域幅を 1 秒あたりの MB 単位で指定します。 VirtualMachine ScaleSet VM ディスクの場合にのみ返されます。 VirtualMachine スケールセットの更新によってのみ更新できます。
diskSizeGB	integer	空のデータディスクのサイズをギガバイト単位で指定します。この要素を使用して、仮想マシンイメージ内のディスクのサイズを上書きできます。プロパティ '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

アタッチするマネージドデータディスクの一覧。

名前	型	説明
caching	CachingTypes	キャッシュの要件を指定します。使用できる値は、 None、ReadOnly、ReadWrite です。既定の動作は、標準ストレージの場合は [なし] です。Premium Storage の ReadOnly。
deleteOption	DiskDeleteOptionTypes	VM の削除時にデータディスクを削除するかデタッチするかを指定します。使用できる値は、Delete です。この値を使用すると、VM の削除時にデータディスクが削除されます。デタッチ。この値を使用すると、VM が削除された後もデータディスクが保持されます。既定値は [デタッチ] に設定されています。
diskEncryptionSet	DiskEncryptionSetParameters	マネージドディスクのカスタマーマネージドディスク暗号化セットリソース ID を指定します。
diskId	string	マネージドデータディスクの ID。
lun	integer	データディスクの論理ユニット番号。この値は、VM 内のデータディスクを識別するために使用されるため、VM に接続されているデータディスクごとに一意である必要があります。指定しない場合、lun は自動的に割り当てられます。
writeAcceleratorEnabled	boolean	ディスクで writeAccelerator を有効または無効にするかどうかを指定します。

DataDisksToDetach

デタッチするマネージドデータディスクの一覧。

名前	型	説明
detachOption	DiskDetachOptionTypes	[ディスクを VM からデタッチする] で使用できるオプションがサポートされています。詳細については、「DetachOption オブジェクトリファレンス」を参照してください。
diskId	string	マネージドデータディスクの ID。

DiffDiskOptions

オペレーティングシステムディスクのエフェメラルディスク設定を指定します。

名前	型	説明
Local	string

DiffDiskPlacement

オペレーティングシステムディスクのエフェメラルディスクの配置を指定します。使用できる値は、 CacheDisk、ResourceDisk、NvmeDisk です。 既定の動作は、VM サイズ用に構成されている場合は CacheDisk 、それ以外の場合は ResourceDisk または NvmeDisk が使用されます。キャッシュディスクを公開する VM サイズをチェックするには、Windows VM と https://docs.microsoft.com/azure/virtual-machines/windows/sizes Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/sizes の VM サイズに関するドキュメントを参照してください。 NvmeDisk の最小 api-version: 2024-03-01。

名前	型	説明
CacheDisk	string
NvmeDisk	string
ResourceDisk	string

DiffDiskSettings

仮想マシンで使用されるオペレーティングシステムディスクのエフェメラルディスク設定を指定します。

名前	型	説明
option	DiffDiskOptions	オペレーティングシステムディスクのエフェメラルディスク設定を指定します。
placement	DiffDiskPlacement	オペレーティングシステムディスクのエフェメラルディスクの配置を指定します。指定できる値は、CacheDisk、ResourceDisk、NvmeDisk です。既定の動作は、VM サイズ用に構成されている場合は CacheDisk 、それ以外の場合は ResourceDisk または NvmeDisk が使用されます。キャッシュディスクを公開する VM サイズをチェックするには、の Windows https://docs.microsoft.com/azure/virtual-machines/windows/sizes VM と Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/sizes の VM サイズに関するドキュメントを参照してください。 NvmeDisk の最小 api-version: 2024-03-01。

DiskControllerTypes

VM 用に構成されたディスクコントローラーの種類を指定します。 メモ： 指定されていない場合、このプロパティは、指定された最小 API バージョンのオペレーティングシステムディスクと VM サイズの機能に基づいて、"hyperVGeneration" が V2 に設定された状態で作成される仮想マシンが既定のディスクコントローラーの種類に設定されます。 VM の割り当てを暗黙的に解除して再割り当てする VM 構成で VM サイズを更新しない限り、ディスクコントローラーの種類を更新する前に VM の割り当てを解除する必要があります。最小 api-version: 2022-08-01。

名前	型	説明
NVMe	string
SCSI	string

DiskCreateOptionTypes

仮想マシンディスクの作成方法を指定します。指定できる値は [アタッチ] です。 この値は、特殊化されたディスクを使用して仮想マシンを作成するときに使用されます。 FromImage: この値は、イメージを使用して仮想マシンを作成するときに使用されます。プラットフォームイメージを使用している場合は、上記の imageReference 要素も使用する必要があります。マーケットプレースイメージを使用している場合は、前に説明した plan 要素も使用する必要があります。

名前	型	説明
Attach	string
Copy	string
Empty	string
FromImage	string
Restore	string

DiskDeleteOptionTypes

VM の削除時に OS ディスクを削除するかデタッチするかを指定します。使用できる値は 、Delete です。 この値を使用すると、VM が削除されると OS ディスクが削除されます。 デタッチ。 この値を使用すると、VM が削除された後も os ディスクが保持されます。既定値は [デタッチ] に設定されています。エフェメラル OS ディスクの場合、既定値は Delete に設定 されます。ユーザーは、エフェメラル OS ディスクの削除オプションを変更できません。

名前	型	説明
Delete	string
Detach	string

DiskDetachOptionTypes

ディスクのデタッチ中に使用するデタッチ動作、または仮想マシンからのデタッチ処理中のデタッチ動作を指定します。サポートされている値: ForceDetach。 detachOption: ForceDetach は、マネージドデータディスクにのみ適用されます。仮想マシンからの予期しない障害が原因でデータディスクの以前のデタッチ試行が完了せず、ディスクがまだ解放されていない場合は、最後の手段として強制デタッチを使用して、VM からディスクを強制的にデタッチします。このデタッチ動作を使用する場合、すべての書き込みがフラッシュされていない可能性があります。 この機能は引き続きプレビュー モードであり、VirtualMachineScaleSet ではサポートされていません。データディスクを強制的にデタッチするには、detachOption: 'ForceDetach' の設定と共にBeDetached を 'true' に更新します。

名前	型	説明
ForceDetach	string

DiskEncryptionSetParameters

マネージドディスクのカスタマーマネージドディスク暗号化セットリソース ID を指定します。

名前	型	説明
id	string	リソース ID

DiskEncryptionSettings

OS ディスクの暗号化設定を指定します。最小 api-version: 2015-06-15。

名前	型	説明
diskEncryptionKey	KeyVaultSecretReference	Key Vault シークレットであるディスク暗号化キーの場所を指定します。
enabled	boolean	仮想マシンでディスク暗号化を有効にするかどうかを指定します。
keyEncryptionKey	KeyVaultKeyReference	Key Vault内のキー暗号化キーの場所を指定します。

ImageReference

使用するイメージに関する情報を指定します。プラットフォームイメージ、マーケットプレースイメージ、または仮想マシンイメージに関する情報を指定できます。この要素は、プラットフォームイメージ、マーケットプレースイメージ、または仮想マシンイメージを使用する場合に必要ですが、他の作成操作では使用されません。

名前	型	説明
communityGalleryImageId	string	VM デプロイのコミュニティギャラリーイメージの一意の ID を指定しました。これは、コミュニティギャラリーイメージの GET 呼び出しからフェッチできます。
exactVersion	string	仮想マシンの作成に使用されるプラットフォームイメージまたはマーケットプレースイメージのバージョンを 10 進数で指定します。この読み取り専用フィールドは、'version' フィールドで指定された値が 'latest' の場合にのみ、'version' と異なります。
id	string	リソース ID
offer	string	仮想マシンの作成に使用するプラットフォームイメージまたはマーケットプレースイメージのオファーを指定します。
publisher	string	イメージの発行元。
sharedGalleryImageId	string	VM デプロイの共有ギャラリーイメージの一意の ID を指定しました。これは、共有ギャラリーイメージの GET 呼び出しからフェッチできます。
sku	string	イメージ SKU。
version	string	仮想マシンの作成に使用するプラットフォームイメージまたはマーケットプレースイメージのバージョンを指定します。使用できる形式は Major.Minor.Build または 'latest' です。メジャー、マイナー、ビルドは 10 進数です。デプロイ時に使用可能な最新バージョンのイメージを使用するには、'latest' を指定します。 'latest' を使用している場合でも、新しいバージョンが使用可能になった場合でも、デプロイ後に VM イメージは自動的に更新されません。ギャラリーイメージのデプロイにはフィールド 'version' を使用しないでください。ギャラリーイメージでは常に 'id' フィールドを使用し、ギャラリーイメージの '最新' バージョンを使用するには、バージョン入力なしで '/subscriptions/{subscriptionId}/resourceGroupName}/providers/Microsoft.Compute/galleryName}/images/{imageName}' を 'id' フィールドに設定してください。

InnerError

内部エラーの詳細。

名前	型	説明
errordetail	string	内部エラーメッセージまたは例外ダンプ。
exceptiontype	string	例外の種類。

KeyVaultKeyReference

Key Vault内のキー暗号化キーの場所を指定します。

名前	型	説明
keyUrl	string	Key Vaultのキー暗号化キーを参照する URL。
sourceVault	SubResource	キーを含むKey Vaultの相対 URL。

KeyVaultSecretReference

Key Vault シークレットであるディスク暗号化キーの場所を指定します。

名前	型	説明
secretUrl	string	Key Vault内のシークレットを参照する URL。
sourceVault	SubResource	シークレットを含むKey Vaultの相対 URL。

ManagedDiskParameters

マネージドディスクのパラメーター。

名前	型	説明
diskEncryptionSet	DiskEncryptionSetParameters	マネージドディスクのカスタマーマネージドディスク暗号化セットリソース ID を指定します。
id	string	リソース ID
securityProfile	VMDiskSecurityProfile	マネージドディスクのセキュリティプロファイルを指定します。
storageAccountType	StorageAccountTypes	マネージドディスクのストレージアカウントの種類を指定します。注: UltraSSD_LRSはデータディスクでのみ使用できます。OS ディスクでは使用できません。

OperatingSystemTypes

オペレーティングシステムの種類。

名前	型	説明
Linux	string
Windows	string

OSDisk

仮想マシンで使用されるオペレーティングシステムディスクに関する情報を指定します。ディスクの詳細については、「 Azure 仮想マシンのディスクと VHD について」を参照してください。

名前	型	説明
caching	CachingTypes	キャッシュの要件を指定します。使用できる値は、 None、ReadOnly、ReadWrite です。既定の動作は、標準ストレージの場合は [なし] です。Premium Storage の ReadOnly。
createOption	DiskCreateOptionTypes	仮想マシンディスクの作成方法を指定します。指定できる値は [アタッチ] です。この値は、特殊化されたディスクを使用して仮想マシンを作成するときに使用されます。 FromImage: この値は、イメージを使用して仮想マシンを作成する場合に使用されます。プラットフォームイメージを使用している場合は、上記の imageReference 要素も使用する必要があります。マーケットプレースイメージを使用している場合は、前に説明した plan 要素も使用する必要があります。
deleteOption	DiskDeleteOptionTypes	VM の削除時に OS ディスクを削除するかデタッチするかを指定します。使用できる値は、Delete です。この値を使用すると、VM が削除されると OS ディスクが削除されます。デタッチ。この値を使用すると、VM が削除された後も os ディスクが保持されます。既定値は [デタッチ] に設定されています。エフェメラル OS ディスクの場合、既定値は Delete に設定されます。ユーザーは、エフェメラル OS ディスクの削除オプションを変更できません。
diffDiskSettings	DiffDiskSettings	仮想マシンで使用されるオペレーティングシステムディスクのエフェメラルディスク設定を指定します。
diskSizeGB	integer	空のデータディスクのサイズをギガバイト単位で指定します。この要素を使用して、仮想マシンイメージ内のディスクのサイズを上書きできます。プロパティ 'diskSizeGB' はディスクのバイト数 x 1024^3 であり、値を 1023 より大きくすることはできません。
encryptionSettings	DiskEncryptionSettings	OS ディスクの暗号化設定を指定します。最小 api-version: 2015-06-15。
image	VirtualHardDisk	ソースユーザーイメージの仮想ハードディスク。仮想ハードディスクは、仮想マシンに接続される前にコピーされます。 SourceImage が指定されている場合、コピー先の仮想ハードドライブが存在しない必要があります。
managedDisk	ManagedDiskParameters	マネージドディスクのパラメーター。
name	string	ディスク名。
osType	OperatingSystemTypes	このプロパティを使用すると、ユーザーイメージまたは特殊化された VHD から VM を作成する場合に、ディスクに含まれる OS の種類を指定できます。使用できる値は、 Windows、Linux です。
vhd	VirtualHardDisk	仮想ハードディスク。
writeAcceleratorEnabled	boolean	ディスクで writeAccelerator を有効または無効にするかどうかを指定します。

securityEncryptionTypes

マネージドディスクの EncryptionType を指定します。 VMGuestState BLOB と共にマネージドディスクを暗号化する場合は DiskWithVMGuestState、VMGuestState BLOB のみの暗号化では VMGuestStateOnly、VMGuestState BLOB にファームウェア状態を保持しない場合は NonPersistedTPM に設定されます。 メモ： これは、機密 VM にのみ設定できます。

名前	型	説明
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

StorageAccountTypes

マネージドディスクのストレージアカウントの種類を指定します。注: UltraSSD_LRSはデータディスクでのみ使用できますが、OS ディスクでは使用できません。

名前	型	説明
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

StorageProfile

仮想マシンのストレージ設定を指定します。

名前	型	説明
dataDisks	DataDisk[]	仮想マシンにデータディスクを追加するために使用されるパラメーターを指定します。ディスクの詳細については、「 Azure 仮想マシンのディスクと VHD について」を参照してください。
diskControllerType	DiskControllerTypes	VM 用に構成されたディスクコントローラーの種類を指定します。メモ：指定されていない場合、このプロパティは、指定された最小 API バージョンのオペレーティングシステムディスクと VM サイズの機能に基づいて、"hyperVGeneration" が V2 に設定された状態で作成されている場合、既定のディスクコントローラーの種類に設定されます。 VM の割り当てを暗黙的に解除して再割り当てする VM 構成で VM サイズを更新しない限り、ディスクコントローラーの種類を更新する前に VM の割り当てを解除する必要があります。最小 api-version: 2022-08-01。
imageReference	ImageReference	使用するイメージに関する情報を指定します。プラットフォームイメージ、マーケットプレースイメージ、または仮想マシンイメージに関する情報を指定できます。この要素は、プラットフォームイメージ、マーケットプレースイメージ、または仮想マシンイメージを使用する場合に必要ですが、他の作成操作では使用されません。
osDisk	OSDisk	仮想マシンで使用されるオペレーティングシステムディスクに関する情報を指定します。ディスクの詳細については、「 Azure 仮想マシンのディスクと VHD について」を参照してください。

SubResource

名前	型	説明
id	string	リソース ID

VirtualHardDisk

仮想ハードディスク。

名前	型	説明
uri	string	仮想ハードディスクの URI を指定します。

VMDiskSecurityProfile

マネージドディスクのセキュリティプロファイルを指定します。

名前	型	説明
diskEncryptionSet	DiskEncryptionSetParameters	カスタマーマネージドキーで暗号化された ConfidentialVM OS ディスクと VMGuest BLOB に使用されるマネージドディスクのカスタマーマネージドディスク暗号化セットリソース ID を指定します。
securityEncryptionType	securityEncryptionTypes	マネージドディスクの EncryptionType を指定します。 VMGuestState BLOB と共にマネージドディスクを暗号化する場合は DiskWithVMGuestState、VMGuestState BLOB のみの暗号化では VMGuestStateOnly、VMGuestState BLOB にファームウェア状態を保持しない場合は NonPersistedTPM に設定されます。メモ：これは、機密 VM にのみ設定できます。

Virtual Machines - Attach Detach Data Disks

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

Scopes

例

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

Sample Request

Sample Response

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

Sample Request

Sample Response

定義

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

その他のリソース