Virtual Machines - Attach Detach Data Disks

Service:

Compute

API Version:

2024-03-01

Gegevensschijven koppelen aan en loskoppelen van de virtuele machine.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep.
subscriptionId	path	True	string	Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
vmName	path	True	string	De naam van de virtuele machine.
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Type	Description
parameters	AttachDetachDataDisksRequest	Parameters die zijn opgegeven voor de bewerking voor het koppelen en loskoppelen van gegevensschijven op de virtuele machine.

Antwoorden

Name	Type	Description
200 OK	StorageProfile	OK
202 Accepted		Geaccepteerd Headers Location: string
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

Sample Request

HTTP

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"
    }
  ]
}

Python

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

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/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

JavaScript

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

/**
 * This sample demonstrates how to Attach and detach data disks to/from the virtual machine.
 *
 * @summary Attach and detach data disks to/from the virtual machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-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

HTTP

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"
    }
  ]
}

Python

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

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/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

JavaScript

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

/**
 * This sample demonstrates how to Attach and detach data disks to/from the virtual machine.
 *
 * @summary Attach and detach data disks to/from the virtual machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-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

Definities

Name	Description
ApiEntityReference	De bronresource-id. Dit kan een momentopname of een schijfherstelpunt zijn van waaruit een schijf moet worden gemaakt.
ApiError	API-fout.
ApiErrorBase	API-foutbasis.
AttachDetachDataDisksRequest	Parameters die zijn opgegeven voor de bewerking voor het koppelen en loskoppelen van gegevensschijven op de virtuele machine.
CachingTypes	Hiermee geeft u de cachevereisten op. Mogelijke waarden zijn: None,ReadOnly,ReadWrite. Het standaardgedrag is: Geen voor Standard-opslag. ReadOnly voor Premium-opslag.
CloudError	Een foutreactie van de Compute-service.
DataDisk	Hiermee geeft u de parameters op die worden gebruikt om een gegevensschijf toe te voegen aan een virtuele machine. Zie Over schijven en VHD's voor virtuele Azure-machines voor meer informatie over schijven.
DataDisksToAttach	De lijst met beheerde gegevensschijven die moeten worden gekoppeld.
DataDisksToDetach	De lijst met beheerde gegevensschijven die moeten worden losgekoppeld.
DiffDiskOptions	Hiermee geeft u de tijdelijke schijfinstellingen voor de besturingssysteemschijf.
DiffDiskPlacement	Hiermee geeft u de tijdelijke schijfplaatsing voor de besturingssysteemschijf op. Mogelijke waarden zijn: CacheDisk,ResourceDisk,NvmeDisk. Het standaardgedrag is: CacheDisk als er een is geconfigureerd voor de VM-grootte, anders wordt ResourceDisk of NvmeDisk gebruikt. Raadpleeg de documentatie over VM-grootte voor Windows-VM op https://docs.microsoft.com/azure/virtual-machines/windows/sizes en Linux-VM op https://docs.microsoft.com/azure/virtual-machines/linux/sizes om te controleren welke VM-grootten een cacheschijf beschikbaar maken. Minimale API-versie voor NvmeDisk: 2024-03-01.
DiffDiskSettings	Hiermee geeft u de tijdelijke schijfinstellingen voor de besturingssysteemschijf die wordt gebruikt door de virtuele machine.
DiskControllerTypes	Hiermee geeft u het type schijfcontroller dat is geconfigureerd voor de VM. Opmerking: Deze eigenschap wordt ingesteld op het standaardtype schijfcontroller als niet opgegeven opgegeven virtuele machine wordt gemaakt met 'hyperVGeneration' ingesteld op V2 op basis van de mogelijkheden van de besturingssysteemschijf en VM-grootte van de opgegeven minimale API-versie. U moet de toewijzing van de VM ongedaan maken voordat u het type schijfcontroller bijwerkt, tenzij u de VM-grootte bijwerkt in de VM-configuratie waarmee impliciet de toewijzing van de VM ongedaan wordt gemaakt en opnieuw wordt toegewezen. Minimale API-versie: 2022-08-01.
DiskCreateOptionTypes	Hiermee geeft u op hoe de schijf van de virtuele machine moet worden gemaakt. Mogelijke waarden zijn Koppelen: deze waarde wordt gebruikt wanneer u een gespecialiseerde schijf gebruikt om de virtuele machine te maken. FromImage: Deze waarde wordt gebruikt wanneer u een installatiekopieën gebruikt om de virtuele machine te maken. Als u een platforminstallatiekopie gebruikt, moet u ook het element imageReference gebruiken dat hierboven wordt beschreven. Als u een Marketplace-installatiekopieën gebruikt, moet u ook het planelement gebruiken dat eerder is beschreven.
DiskDeleteOptionTypes	Hiermee geeft u op of de besturingssysteemschijf moet worden verwijderd of losgekoppeld bij het verwijderen van de VM. Mogelijke waarden zijn: Verwijderen. Als deze waarde wordt gebruikt, wordt de besturingssysteemschijf verwijderd wanneer de VM wordt verwijderd. Loskoppelen. Als deze waarde wordt gebruikt, blijft de besturingssysteemschijf behouden nadat de VM is verwijderd. De standaardwaarde is ingesteld op Loskoppelen. Voor een tijdelijke besturingssysteemschijf is de standaardwaarde ingesteld op Verwijderen. De gebruiker kan de verwijderingsoptie voor een tijdelijke besturingssysteemschijf niet wijzigen.
DiskDetachOptionTypes	Hiermee geeft u het loskoppelgedrag op dat moet worden gebruikt tijdens het loskoppelen van een schijf of dat al bezig is met het loskoppelen van de virtuele machine. Ondersteunde waarden: ForceDetach. detachOption: ForceDetach is alleen van toepassing op beheerde gegevensschijven. Als een eerdere loskoppelpoging van de gegevensschijf niet is voltooid vanwege een onverwachte fout van de virtuele machine en de schijf nog steeds niet wordt vrijgegeven, gebruikt u geforceerd loskoppelen als laatste redmiddel om de schijf geforceerd los te koppelen van de VM. Mogelijk zijn niet alle schrijfbewerkingen leeggemaakt bij het gebruik van dit loskoppelgedrag. Deze functie bevindt zich nog steeds in de preview-modus en wordt niet ondersteund voor VirtualMachineScaleSet. Een gegevensschijf bijwerken geforceerd loskoppelen naar 'true' en de instelling detachOption: 'ForceDetach'.
DiskEncryptionSetParameters	Hiermee geeft u de resource-id van de door de klant beheerde schijfversleutelingsset op voor de beheerde schijf.
DiskEncryptionSettings	Hiermee geeft u de versleutelingsinstellingen voor de besturingssysteemschijf. Minimale API-versie: 2015-06-15.
ImageReference	Hiermee geeft u informatie op over de afbeelding die moet worden gebruikt. U kunt informatie opgeven over platforminstallatiekopieën, marketplace-installatiekopieën of installatiekopieën van virtuele machines. Dit element is vereist als u een platforminstallatiekopie, marketplace-installatiekopie of installatiekopie van een virtuele machine wilt gebruiken, maar wordt niet gebruikt bij andere maakbewerkingen.
InnerError	Details van interne fout.
KeyVaultKeyReference	Hiermee geeft u de locatie van de sleutelversleutelingssleutel in Key Vault.
KeyVaultSecretReference	Hiermee geeft u de locatie van de schijfversleutelingssleutel op. Dit is een Key Vault Geheim.
ManagedDiskParameters	De parameters van de beheerde schijf.
OperatingSystemTypes	Het type besturingssysteem.
OSDisk	Hiermee geeft u informatie op over de besturingssysteemschijf die wordt gebruikt door de virtuele machine. Zie Over schijven en VHD's voor virtuele Azure-machines voor meer informatie over schijven.
securityEncryptionTypes	Hiermee geeft u het EncryptionType van de beheerde schijf. Deze is ingesteld op DiskWithVMGuestState voor versleuteling van de beheerde schijf samen met de VMGuestState-blob, VMGuestStateOnly voor versleuteling van alleen de VMGuestState-blob en NonPersistedTPM voor niet-persistente firmwarestatus in de VMGuestState-blob. Opmerking: Deze kan alleen worden ingesteld voor vertrouwelijke VM's.
StorageAccountTypes	Hiermee geeft u het opslagaccounttype voor de beheerde schijf op. OPMERKING: UltraSSD_LRS kan alleen worden gebruikt met gegevensschijven, niet met besturingssysteemschijf.
StorageProfile	Hiermee geeft u de opslaginstellingen voor de schijven van de virtuele machine op.
SubResource
VirtualHardDisk	De virtuele harde schijf.
VMDiskSecurityProfile	Hiermee geeft u het beveiligingsprofiel voor de beheerde schijf.

ApiEntityReference

De bronresource-id. Dit kan een momentopname of een schijfherstelpunt zijn van waaruit een schijf moet worden gemaakt.

Name	Type	Description
id	string	De ARM-resource-id in de vorm van /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

API-fout.

Name	Type	Description
code	string	De foutcode.
details	ApiErrorBase[]	De API-foutdetails
innererror	InnerError	De interne API-fout
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

ApiErrorBase

API-foutbasis.

Name	Type	Description
code	string	De foutcode.
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

AttachDetachDataDisksRequest

Parameters die zijn opgegeven voor de bewerking voor het koppelen en loskoppelen van gegevensschijven op de virtuele machine.

Name	Type	Description
dataDisksToAttach	DataDisksToAttach[]	De lijst met beheerde gegevensschijven die moeten worden gekoppeld.
dataDisksToDetach	DataDisksToDetach[]	De lijst met beheerde gegevensschijven die moeten worden losgekoppeld.

CachingTypes

Hiermee geeft u de cachevereisten op. Mogelijke waarden zijn: None,ReadOnly,ReadWrite. Het standaardgedrag is: Geen voor Standard-opslag. ReadOnly voor Premium-opslag.

Name	Type	Description
None	string
ReadOnly	string
ReadWrite	string

CloudError

Een foutreactie van de Compute-service.

Name	Type	Description
error	ApiError	API-fout.

DataDisk

Hiermee geeft u de parameters op die worden gebruikt om een gegevensschijf toe te voegen aan een virtuele machine. Zie Over schijven en VHD's voor virtuele Azure-machines voor meer informatie over schijven.

Name	Type	Description
caching	CachingTypes	Hiermee geeft u de cachevereisten op. Mogelijke waarden zijn: None,ReadOnly,ReadWrite. Het standaardgedrag is: Geen voor Standard-opslag. ReadOnly voor Premium-opslag.
createOption	DiskCreateOptionTypes	Hiermee geeft u op hoe de schijf van de virtuele machine moet worden gemaakt. Mogelijke waarden zijn Koppelen: deze waarde wordt gebruikt wanneer u een gespecialiseerde schijf gebruikt om de virtuele machine te maken. FromImage: Deze waarde wordt gebruikt wanneer u een installatiekopieën gebruikt om de gegevensschijf van de virtuele machine te maken. Als u een platforminstallatiekopie gebruikt, moet u ook het element imageReference gebruiken dat hierboven wordt beschreven. Als u een Marketplace-installatiekopieën gebruikt, moet u ook het planelement gebruiken dat eerder is beschreven. Lege: Deze waarde wordt gebruikt bij het maken van een lege gegevensschijf. Kopiëren: Deze waarde wordt gebruikt om een gegevensschijf te maken op basis van een momentopname of een andere schijf. Herstellen: Deze waarde wordt gebruikt om een gegevensschijf te maken vanaf een schijfherstelpunt.
deleteOption	DiskDeleteOptionTypes	Hiermee geeft u op of de gegevensschijf moet worden verwijderd of losgekoppeld bij het verwijderen van de VM. Mogelijke waarden zijn: Verwijderen. Als deze waarde wordt gebruikt, wordt de gegevensschijf verwijderd wanneer de VM wordt verwijderd. Loskoppelen. Als deze waarde wordt gebruikt, blijft de gegevensschijf behouden nadat de VM is verwijderd. De standaardwaarde is ingesteld op Loskoppelen.
detachOption	DiskDetachOptionTypes	Hiermee geeft u het loskoppelgedrag op dat moet worden gebruikt tijdens het loskoppelen van een schijf of dat al bezig is met het loskoppelen van de virtuele machine. Ondersteunde waarden: ForceDetach. detachOption: ForceDetach is alleen van toepassing op beheerde gegevensschijven. Als een eerdere loskoppelpoging van de gegevensschijf niet is voltooid vanwege een onverwachte fout van de virtuele machine en de schijf nog steeds niet wordt vrijgegeven, gebruikt u geforceerd loskoppelen als laatste redmiddel om de schijf geforceerd los te koppelen van de VM. Mogelijk zijn niet alle schrijfbewerkingen leeggemaakt bij het gebruik van dit loskoppelgedrag. Deze functie bevindt zich nog steeds in de preview-modus en wordt niet ondersteund voor VirtualMachineScaleSet. Een gegevensschijf bijwerken geforceerd loskoppelen naar 'true' en de instelling detachOption: 'ForceDetach'.
diskIOPSReadWrite	integer	Hiermee geeft u de Read-Write IOPS voor de beheerde schijf wanneer StorageAccountType is UltraSSD_LRS. Alleen geretourneerd voor VM-schijven met VirtualMachine ScaleSet. Kan alleen worden bijgewerkt via updates voor de VirtualMachine-schaalset.
diskMBpsReadWrite	integer	Hiermee geeft u de bandbreedte in MB per seconde voor de beheerde schijf op wanneer StorageAccountType is UltraSSD_LRS. Alleen geretourneerd voor VM-schijven met VirtualMachine ScaleSet. Kan alleen worden bijgewerkt via updates voor de VirtualMachine-schaalset.
diskSizeGB	integer	Hiermee geeft u de grootte van een lege gegevensschijf in gigabytes. Dit element kan worden gebruikt om de grootte van de schijf in een installatiekopieën van een virtuele machine te overschrijven. De eigenschap diskSizeGB is het aantal bytes x 1024^3 voor de schijf en de waarde mag niet groter zijn dan 1023.
image	VirtualHardDisk	De virtuele harde schijf van de brongebruikerkopieën. De virtuele harde schijf wordt gekopieerd voordat deze wordt gekoppeld aan de virtuele machine. Als SourceImage is opgegeven, mag de virtuele doelschijf niet bestaan.
lun	integer	Hiermee geeft u het nummer van de logische eenheid van de gegevensschijf. Deze waarde wordt gebruikt om gegevensschijven binnen de VM te identificeren en moet daarom uniek zijn voor elke gegevensschijf die aan een virtuele machine is gekoppeld.
managedDisk	ManagedDiskParameters	De parameters van de beheerde schijf.
name	string	De schijfnaam.
sourceResource	ApiEntityReference	De bronresource-id. Dit kan een momentopname of een schijfherstelpunt zijn van waaruit een schijf moet worden gemaakt.
toBeDetached	boolean	Hiermee geeft u op of de gegevensschijf wordt losgekoppeld van de VirtualMachine/VirtualMachineScaleset
vhd	VirtualHardDisk	De virtuele harde schijf.
writeAcceleratorEnabled	boolean	Hiermee geeft u op of writeAccelerator moet worden in- of uitgeschakeld op de schijf.

DataDisksToAttach

De lijst met beheerde gegevensschijven die moeten worden gekoppeld.

Name	Type	Description
caching	CachingTypes	Hiermee geeft u de cachevereisten op. Mogelijke waarden zijn: None,ReadOnly,ReadWrite. Het standaardgedrag is: Geen voor Standard-opslag. ReadOnly voor Premium-opslag.
deleteOption	DiskDeleteOptionTypes	Hiermee geeft u op of de gegevensschijf moet worden verwijderd of losgekoppeld bij het verwijderen van de VM. Mogelijke waarden zijn: Verwijderen. Als deze waarde wordt gebruikt, wordt de gegevensschijf verwijderd wanneer de VM wordt verwijderd. Loskoppelen. Als deze waarde wordt gebruikt, blijft de gegevensschijf behouden nadat de VM is verwijderd. De standaardwaarde is ingesteld op Loskoppelen.
diskEncryptionSet	DiskEncryptionSetParameters	Hiermee geeft u de resource-id van de door de klant beheerde schijfversleutelingsset op voor de beheerde schijf.
diskId	string	Id van de beheerde gegevensschijf.
lun	integer	Het logische eenheidsnummer van de gegevensschijf. Deze waarde wordt gebruikt om gegevensschijven binnen de VM te identificeren en moet daarom uniek zijn voor elke gegevensschijf die aan een virtuele machine is gekoppeld. Indien niet opgegeven, zou lun automatisch worden toegewezen.
writeAcceleratorEnabled	boolean	Hiermee geeft u op of writeAccelerator moet worden in- of uitgeschakeld op de schijf.

DataDisksToDetach

De lijst met beheerde gegevensschijven die moeten worden losgekoppeld.

Name	Type	Description
detachOption	DiskDetachOptionTypes	Ondersteunde opties die beschikbaar zijn voor het loskoppelen van een schijf van een VM. Raadpleeg DetachOption-objectverwijzing voor meer informatie.
diskId	string	Id van de beheerde gegevensschijf.

DiffDiskOptions

Hiermee geeft u de tijdelijke schijfinstellingen voor de besturingssysteemschijf.

Name	Type	Description
Local	string

DiffDiskPlacement

Hiermee geeft u de tijdelijke schijfplaatsing voor de besturingssysteemschijf op. Mogelijke waarden zijn: CacheDisk,ResourceDisk,NvmeDisk. Het standaardgedrag is: CacheDisk als er een is geconfigureerd voor de VM-grootte, anders wordt ResourceDisk of NvmeDisk gebruikt. Raadpleeg de documentatie over VM-grootte voor Windows-VM op https://docs.microsoft.com/azure/virtual-machines/windows/sizes en Linux-VM op https://docs.microsoft.com/azure/virtual-machines/linux/sizes om te controleren welke VM-grootten een cacheschijf beschikbaar maken. Minimale API-versie voor NvmeDisk: 2024-03-01.

Name	Type	Description
CacheDisk	string
NvmeDisk	string
ResourceDisk	string

DiffDiskSettings

Hiermee geeft u de tijdelijke schijfinstellingen voor de besturingssysteemschijf die wordt gebruikt door de virtuele machine.

Name	Type	Description
option	DiffDiskOptions	Hiermee geeft u de tijdelijke schijfinstellingen voor de besturingssysteemschijf.
placement	DiffDiskPlacement	Hiermee geeft u de tijdelijke schijfplaatsing voor de besturingssysteemschijf op. Mogelijke waarden zijn: CacheDisk,ResourceDisk,NvmeDisk. Het standaardgedrag is: CacheDisk als er een is geconfigureerd voor de VM-grootte, anders Wordt ResourceDisk of NvmeDisk gebruikt. Raadpleeg de documentatie over VM-grootte voor Windows-VM op https://docs.microsoft.com/azure/virtual-machines/windows/sizes en Linux-VM op https://docs.microsoft.com/azure/virtual-machines/linux/sizes om te controleren welke VM-grootten een cacheschijf beschikbaar maken. Minimale API-versie voor NvmeDisk: 2024-03-01.

DiskControllerTypes

Hiermee geeft u het type schijfcontroller dat is geconfigureerd voor de VM. Opmerking: Deze eigenschap wordt ingesteld op het standaardtype schijfcontroller als niet opgegeven opgegeven virtuele machine wordt gemaakt met 'hyperVGeneration' ingesteld op V2 op basis van de mogelijkheden van de besturingssysteemschijf en VM-grootte van de opgegeven minimale API-versie. U moet de toewijzing van de VM ongedaan maken voordat u het type schijfcontroller bijwerkt, tenzij u de VM-grootte bijwerkt in de VM-configuratie waarmee impliciet de toewijzing van de VM ongedaan wordt gemaakt en opnieuw wordt toegewezen. Minimale API-versie: 2022-08-01.

Name	Type	Description
NVMe	string
SCSI	string

DiskCreateOptionTypes

Hiermee geeft u op hoe de schijf van de virtuele machine moet worden gemaakt. Mogelijke waarden zijn Koppelen: deze waarde wordt gebruikt wanneer u een gespecialiseerde schijf gebruikt om de virtuele machine te maken. FromImage: Deze waarde wordt gebruikt wanneer u een installatiekopieën gebruikt om de virtuele machine te maken. Als u een platforminstallatiekopie gebruikt, moet u ook het element imageReference gebruiken dat hierboven wordt beschreven. Als u een Marketplace-installatiekopieën gebruikt, moet u ook het planelement gebruiken dat eerder is beschreven.

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

DiskDeleteOptionTypes

Hiermee geeft u op of de besturingssysteemschijf moet worden verwijderd of losgekoppeld bij het verwijderen van de VM. Mogelijke waarden zijn: Verwijderen. Als deze waarde wordt gebruikt, wordt de besturingssysteemschijf verwijderd wanneer de VM wordt verwijderd. Loskoppelen. Als deze waarde wordt gebruikt, blijft de besturingssysteemschijf behouden nadat de VM is verwijderd. De standaardwaarde is ingesteld op Loskoppelen. Voor een tijdelijke besturingssysteemschijf is de standaardwaarde ingesteld op Verwijderen. De gebruiker kan de verwijderingsoptie voor een tijdelijke besturingssysteemschijf niet wijzigen.

Name	Type	Description
Delete	string
Detach	string

DiskDetachOptionTypes

Hiermee geeft u het loskoppelgedrag op dat moet worden gebruikt tijdens het loskoppelen van een schijf of dat al bezig is met het loskoppelen van de virtuele machine. Ondersteunde waarden: ForceDetach. detachOption: ForceDetach is alleen van toepassing op beheerde gegevensschijven. Als een eerdere loskoppelpoging van de gegevensschijf niet is voltooid vanwege een onverwachte fout van de virtuele machine en de schijf nog steeds niet wordt vrijgegeven, gebruikt u geforceerd loskoppelen als laatste redmiddel om de schijf geforceerd los te koppelen van de VM. Mogelijk zijn niet alle schrijfbewerkingen leeggemaakt bij het gebruik van dit loskoppelgedrag. Deze functie bevindt zich nog steeds in de preview-modus en wordt niet ondersteund voor VirtualMachineScaleSet. Een gegevensschijf bijwerken geforceerd loskoppelen naar 'true' en de instelling detachOption: 'ForceDetach'.

Name	Type	Description
ForceDetach	string

DiskEncryptionSetParameters

Hiermee geeft u de resource-id van de door de klant beheerde schijfversleutelingsset op voor de beheerde schijf.

Name	Type	Description
id	string	Resource-id

DiskEncryptionSettings

Hiermee geeft u de versleutelingsinstellingen voor de besturingssysteemschijf. Minimale API-versie: 2015-06-15.

Name	Type	Description
diskEncryptionKey	KeyVaultSecretReference	Hiermee geeft u de locatie van de schijfversleutelingssleutel op. Dit is een Key Vault Geheim.
enabled	boolean	Hiermee geeft u op of schijfversleuteling moet worden ingeschakeld op de virtuele machine.
keyEncryptionKey	KeyVaultKeyReference	Hiermee geeft u de locatie van de sleutelversleutelingssleutel in Key Vault.

ImageReference

Hiermee geeft u informatie op over de afbeelding die moet worden gebruikt. U kunt informatie opgeven over platforminstallatiekopieën, marketplace-installatiekopieën of installatiekopieën van virtuele machines. Dit element is vereist als u een platforminstallatiekopie, marketplace-installatiekopie of installatiekopie van een virtuele machine wilt gebruiken, maar wordt niet gebruikt bij andere maakbewerkingen.

Name	Type	Description
communityGalleryImageId	string	De unieke id van de communitygalerie-installatiekopieën opgegeven voor vm-implementatie. Dit kan worden opgehaald uit de get-aanroep van de communitygalerieafbeelding.
exactVersion	string	Hiermee geeft u in decimale getallen de versie van de platforminstallatiekopieën of marketplace-installatiekopieën op die worden gebruikt om de virtuele machine te maken. Dit alleen-lezen veld verschilt van 'versie', alleen als de waarde die is opgegeven in het veld 'versie' 'meest recente' is.
id	string	Resource-id
offer	string	Hiermee geeft u de aanbieding van de platforminstallatiekopieën of marketplace-installatiekopieën op die worden gebruikt om de virtuele machine te maken.
publisher	string	De uitgever van de installatiekopieën.
sharedGalleryImageId	string	De unieke id van de installatiekopieën van de gedeelde galerie opgegeven voor vm-implementatie. Dit kan worden opgehaald uit de GET-aanroep van de gedeelde galerieafbeelding.
sku	string	De installatiekopieën-SKU.
version	string	Hiermee geeft u de versie van de platforminstallatiekopieën of marketplace-installatiekopieën op die worden gebruikt om de virtuele machine te maken. De toegestane indelingen zijn Major.Minor.Build of 'latest'. Major, Minor en Build zijn decimale getallen. Specificeer 'nieuwste' om de nieuwste versie van een installatiekopie te gebruiken die beschikbaar is op de implementatietijd. Zelfs als u 'nieuwste' gebruikt, wordt de VM-installatiekopieën niet automatisch bijgewerkt na de implementatie, zelfs niet als er een nieuwe versie beschikbaar komt. Gebruik het veld 'versie' niet voor de implementatie van galerieafbeeldingen. De installatiekopieën van de galerie moeten altijd het veld 'id' gebruiken voor implementatie. Als u de nieuwste versie van de galerie-installatiekopieën wilt gebruiken, stelt u '/subscriptions/{subscriptionId}/resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName} in het veld 'id' in zonder versie-invoer.

InnerError

Details van interne fout.

Name	Type	Description
errordetail	string	Het interne foutbericht of de uitzonderingsdump.
exceptiontype	string	Het uitzonderingstype.

KeyVaultKeyReference

Hiermee geeft u de locatie van de sleutelversleutelingssleutel in Key Vault.

Name	Type	Description
keyUrl	string	De URL die verwijst naar een sleutelversleutelingssleutel in Key Vault.
sourceVault	SubResource	De relatieve URL van de Key Vault die de sleutel bevat.

KeyVaultSecretReference

Hiermee geeft u de locatie van de schijfversleutelingssleutel op. Dit is een Key Vault Geheim.

Name	Type	Description
secretUrl	string	De URL die verwijst naar een geheim in een Key Vault.
sourceVault	SubResource	De relatieve URL van de Key Vault die het geheim bevat.

ManagedDiskParameters

De parameters van de beheerde schijf.

Name	Type	Description
diskEncryptionSet	DiskEncryptionSetParameters	Hiermee geeft u de resource-id van de door de klant beheerde schijfversleutelingsset op voor de beheerde schijf.
id	string	Resource-id
securityProfile	VMDiskSecurityProfile	Hiermee geeft u het beveiligingsprofiel voor de beheerde schijf.
storageAccountType	StorageAccountTypes	Hiermee geeft u het opslagaccounttype voor de beheerde schijf op. OPMERKING: UltraSSD_LRS kan alleen worden gebruikt met gegevensschijven, niet met besturingssysteemschijf.

OperatingSystemTypes

Het type besturingssysteem.

Name	Type	Description
Linux	string
Windows	string

OSDisk

Hiermee geeft u informatie op over de besturingssysteemschijf die wordt gebruikt door de virtuele machine. Zie Over schijven en VHD's voor virtuele Azure-machines voor meer informatie over schijven.

Name	Type	Description
caching	CachingTypes	Hiermee geeft u de cachevereisten op. Mogelijke waarden zijn: None,ReadOnly,ReadWrite. Het standaardgedrag is: Geen voor Standard-opslag. ReadOnly voor Premium-opslag.
createOption	DiskCreateOptionTypes	Hiermee geeft u op hoe de schijf van de virtuele machine moet worden gemaakt. Mogelijke waarden zijn Koppelen: deze waarde wordt gebruikt wanneer u een gespecialiseerde schijf gebruikt om de virtuele machine te maken. FromImage: Deze waarde wordt gebruikt wanneer u een installatiekopieën gebruikt om de virtuele machine te maken. Als u een platforminstallatiekopie gebruikt, moet u ook het element imageReference gebruiken dat hierboven wordt beschreven. Als u een Marketplace-installatiekopieën gebruikt, moet u ook het planelement gebruiken dat eerder is beschreven.
deleteOption	DiskDeleteOptionTypes	Hiermee geeft u op of de besturingssysteemschijf moet worden verwijderd of losgekoppeld bij het verwijderen van de VM. Mogelijke waarden zijn: Verwijderen. Als deze waarde wordt gebruikt, wordt de besturingssysteemschijf verwijderd wanneer de VM wordt verwijderd. Loskoppelen. Als deze waarde wordt gebruikt, blijft de besturingssysteemschijf behouden nadat de VM is verwijderd. De standaardwaarde is ingesteld op Loskoppelen. Voor een tijdelijke besturingssysteemschijf is de standaardwaarde ingesteld op Verwijderen. De gebruiker kan de verwijderingsoptie voor een tijdelijke besturingssysteemschijf niet wijzigen.
diffDiskSettings	DiffDiskSettings	Hiermee geeft u de tijdelijke schijfinstellingen voor de besturingssysteemschijf die wordt gebruikt door de virtuele machine.
diskSizeGB	integer	Hiermee geeft u de grootte van een lege gegevensschijf in gigabytes. Dit element kan worden gebruikt om de grootte van de schijf in een installatiekopieën van een virtuele machine te overschrijven. De eigenschap diskSizeGB is het aantal bytes x 1024^3 voor de schijf en de waarde mag niet groter zijn dan 1023.
encryptionSettings	DiskEncryptionSettings	Hiermee geeft u de versleutelingsinstellingen voor de besturingssysteemschijf. Minimale API-versie: 2015-06-15.
image	VirtualHardDisk	De virtuele harde schijf van de brongebruikerkopieën. De virtuele harde schijf wordt gekopieerd voordat deze wordt gekoppeld aan de virtuele machine. Als SourceImage is opgegeven, mag de virtuele doelschijf niet bestaan.
managedDisk	ManagedDiskParameters	De parameters van de beheerde schijf.
name	string	De schijfnaam.
osType	OperatingSystemTypes	Met deze eigenschap kunt u het type besturingssysteem opgeven dat is opgenomen in de schijf als u een VM maakt op basis van een gebruikersinstallatiekopieën of een gespecialiseerde VHD. Mogelijke waarden zijn: Windows,Linux.
vhd	VirtualHardDisk	De virtuele harde schijf.
writeAcceleratorEnabled	boolean	Hiermee geeft u op of writeAccelerator moet worden in- of uitgeschakeld op de schijf.

securityEncryptionTypes

Hiermee geeft u het EncryptionType van de beheerde schijf. Deze is ingesteld op DiskWithVMGuestState voor versleuteling van de beheerde schijf samen met de VMGuestState-blob, VMGuestStateOnly voor versleuteling van alleen de VMGuestState-blob en NonPersistedTPM voor niet-persistente firmwarestatus in de VMGuestState-blob. Opmerking: Deze kan alleen worden ingesteld voor vertrouwelijke VM's.

Name	Type	Description
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

StorageAccountTypes

Hiermee geeft u het opslagaccounttype voor de beheerde schijf op. OPMERKING: UltraSSD_LRS kan alleen worden gebruikt met gegevensschijven, niet met besturingssysteemschijf.

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

StorageProfile

Hiermee geeft u de opslaginstellingen voor de schijven van de virtuele machine op.

Name	Type	Description
dataDisks	DataDisk[]	Hiermee geeft u de parameters op die worden gebruikt om een gegevensschijf toe te voegen aan een virtuele machine. Zie Over schijven en VHD's voor virtuele Azure-machines voor meer informatie over schijven.
diskControllerType	DiskControllerTypes	Hiermee geeft u het type schijfcontroller dat is geconfigureerd voor de VM. Opmerking: Deze eigenschap wordt ingesteld op het standaardtype schijfcontroller als niet opgegeven opgegeven virtuele machine wordt gemaakt met 'hyperVGeneration' ingesteld op V2 op basis van de mogelijkheden van de besturingssysteemschijf en VM-grootte van de opgegeven minimale API-versie. U moet de toewijzing van de VM ongedaan maken voordat u het type schijfcontroller bijwerkt, tenzij u de VM-grootte bijwerkt in de VM-configuratie waarmee impliciet de toewijzing van de VM ongedaan wordt gemaakt en opnieuw wordt toegewezen. Minimale API-versie: 2022-08-01.
imageReference	ImageReference	Hiermee geeft u informatie op over de afbeelding die moet worden gebruikt. U kunt informatie opgeven over platforminstallatiekopieën, marketplace-installatiekopieën of installatiekopieën van virtuele machines. Dit element is vereist als u een platforminstallatiekopie, marketplace-installatiekopie of installatiekopie van een virtuele machine wilt gebruiken, maar wordt niet gebruikt bij andere maakbewerkingen.
osDisk	OSDisk	Hiermee geeft u informatie op over de besturingssysteemschijf die wordt gebruikt door de virtuele machine. Zie Over schijven en VHD's voor virtuele Azure-machines voor meer informatie over schijven.

SubResource

Name	Type	Description
id	string	Resource-id

VirtualHardDisk

De virtuele harde schijf.

Name	Type	Description
uri	string	Hiermee geeft u de URI van de virtuele harde schijf.

VMDiskSecurityProfile

Hiermee geeft u het beveiligingsprofiel voor de beheerde schijf.

Name	Type	Description
diskEncryptionSet	DiskEncryptionSetParameters	Hiermee geeft u de resource-id van de door de klant beheerde schijfversleutelingsset op voor de beheerde schijf die wordt gebruikt voor door de klant versleutelde ConfidentialVM-besturingssysteemschijf en VMGuest-blob.
securityEncryptionType	securityEncryptionTypes	Hiermee geeft u het EncryptionType van de beheerde schijf. Deze is ingesteld op DiskWithVMGuestState voor versleuteling van de beheerde schijf samen met de VMGuestState-blob, VMGuestStateOnly voor versleuteling van alleen de VMGuestState-blob en NonPersistedTPM voor niet-persistente firmwarestatus in de VMGuestState-blob. Opmerking: Deze kan alleen worden ingesteld voor vertrouwelijke VM's.