Virtual Machines - Attach Detach Data Disks

Tjänst:

Compute

API-version:

2024-07-01

Koppla och koppla från datadiskar till/från den virtuella datorn.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen.
subscriptionId	path	True	string	Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
vmName	path	True	string	Namnet på den virtuella datorn.
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Typ	Description
parameters	AttachDetachDataDisksRequest	Parametrar som tillhandahålls för att koppla och koppla från datadiskar på den virtuella datorn.

Svar

Name	Typ	Description
200 OK	StorageProfile	OKEJ
202 Accepted		Accepterad Sidhuvuden Location: string
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

Exempelbegäran

HTTP

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

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

Java

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

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

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

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

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


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

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


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

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

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

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

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

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-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.json
 */
async function virtualMachineAttachDetachDataDisksMaximumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const vmName = "aaaaaaaaaaaaaaaaaaaa";
  const parameters = {
    dataDisksToAttach: [
      {
        caching: "ReadOnly",
        deleteOption: "Delete",
        diskEncryptionSet: {
          id: "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}",
        },
        diskId:
          "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
        lun: 1,
        writeAcceleratorEnabled: true,
      },
      {
        caching: "ReadWrite",
        deleteOption: "Detach",
        diskEncryptionSet: {
          id: "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}",
        },
        diskId:
          "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e",
        lun: 2,
        writeAcceleratorEnabled: false,
      },
    ],
    dataDisksToDetach: [
      {
        detachOption: "ForceDetach",
        diskId:
          "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x",
      },
      {
        detachOption: "ForceDetach",
        diskId:
          "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_4_disk4_4d4e784bdafa49baa780eb2d256ff41z",
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.beginAttachDetachDataDisksAndWait(
    resourceGroupName,
    vmName,
    parameters,
  );
  console.log(result);
}

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

dotnet

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

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

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

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

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

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

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

Exempelsvar

Statuskod:

200

location: https://foo.com/operationstatus

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

Statuskod:

202

location: https://foo.com/operationstatus

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

Exempelbegäran

HTTP

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

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

Java

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

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

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

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

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


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

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


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

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

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

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

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

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-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.json
 */
async function virtualMachineAttachDetachDataDisksMinimumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const vmName = "azure-vm";
  const parameters = {
    dataDisksToAttach: [
      {
        diskId:
          "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
      },
    ],
    dataDisksToDetach: [
      {
        diskId:
          "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x",
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.beginAttachDetachDataDisksAndWait(
    resourceGroupName,
    vmName,
    parameters,
  );
  console.log(result);
}

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

dotnet

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

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

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

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

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

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

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

Exempelsvar

Statuskod:

200

location: https://foo.com/operationstatus

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

Statuskod:

202

location: https://foo.com/operationstatus

Definitioner

Name	Description
ApiEntityReference	Källresursidentifieraren. Det kan vara en ögonblicksbild eller en diskåterställningspunkt för att skapa en disk.
ApiError	Api-fel.
ApiErrorBase	Api-felbas.
AttachDetachDataDisksRequest	Parametrar som tillhandahålls för att koppla och koppla från datadiskar på den virtuella datorn.
CachingTypes	Anger cachelagringskraven. Möjliga värden är: Ingen,ReadOnlyReadWrite. Standardbeteendet är: Ingen för standardlagring. ReadOnly för Premium Storage.
CloudError	Ett felsvar från Compute-tjänsten.
DataDisk	Anger de parametrar som används för att lägga till en datadisk till en virtuell dator. Mer information om diskar finns i Om diskar och virtuella hårddiskar för virtuella Azure-datorer.
DataDisksToAttach	Listan över hanterade datadiskar som ska kopplas.
DataDisksToDetach	Listan över hanterade datadiskar som ska kopplas från.
DiffDiskOptions	Anger tillfälliga diskinställningar för operativsystemdisken.
DiffDiskPlacement	Anger den tillfälliga diskplaceringen för operativsystemdisken. Möjliga värden är: CacheDisk,ResourceDiskNvmeDisk. Standardbeteendet är: CacheDisk om en har konfigurerats för den virtuella datorns storlek, annars används ResourceDisk eller NvmeDisk. Se dokumentationen om VM-storlek för virtuella Windows-datorer på https://docs.microsoft.com/azure/virtual-machines/windows/sizes och virtuell Linux-dator på https://docs.microsoft.com/azure/virtual-machines/linux/sizes för att kontrollera vilka VM-storlekar som exponerar en cachedisk. Lägsta api-version för NvmeDisk: 2024-03-01.
DiffDiskSettings	Anger tillfälliga diskinställningar för den operativsystemdisk som används av den virtuella datorn.
DiskControllerTypes	Anger vilken typ av diskkontrollant som konfigurerats för den virtuella datorn. Obs! Den här egenskapen anges till standardtypen för diskkontrollanten om den inte anges, förutsatt att den virtuella datorn skapas med "hyperVGeneration" inställt på V2 baserat på funktionerna för operativsystemdisken och VM-storleken från den angivna lägsta API-versionen. Du måste frigöra den virtuella datorn innan du uppdaterar dess typ av diskkontrollant såvida du inte uppdaterar vm-storleken i VM-konfigurationen som implicit frigör och omallokerar den virtuella datorn. Lägsta API-version: 2022-08-01.
DiskCreateOptionTypes	Anger hur den virtuella datordisken ska skapas. Möjliga värden är Bifoga: Det här värdet används när du använder en specialiserad disk för att skapa den virtuella datorn. FromImage: Det här värdet används när du använder en avbildning för att skapa den virtuella datorn. Om du använder en plattformsavbildning bör du också använda imageReference-elementet som beskrivs ovan. Om du använder en Marketplace-avbildning bör du också använda det planelement som beskrevs tidigare.
DiskDeleteOptionTypes	Anger om OS-disken ska tas bort eller kopplas från när den virtuella datorn tas bort. Möjliga värden är: Ta bort. Om det här värdet används tas OS-disken bort när den virtuella datorn tas bort. Lösgöra. Om det här värdet används behålls os-disken när den virtuella datorn har tagits bort. Standardvärdet är inställt på Koppla från. För en tillfällig OS-disk är standardvärdet inställt på Ta bort. Användaren kan inte ändra borttagningsalternativet för en tillfällig OS-disk.
DiskDetachOptionTypes	Anger det frånkopplingsbeteende som ska användas när en disk kopplas från eller som redan håller på att kopplas från från den virtuella datorn. Värden som stöds: ForceDetach. detachOption: ForceDetach gäller endast för hanterade datadiskar. Om ett tidigare frånkopplingsförsök av datadisken inte slutfördes på grund av ett oväntat fel från den virtuella datorn och disken fortfarande inte har släppts använder du force-detach som ett sista utvägsalternativ för att koppla från disken med två våld från den virtuella datorn. Alla skrivningar kanske inte har tömts när du använder det här frånkopplingsbeteendet. För att tvinga bort en datadiskuppdatering tillBeDetached till "true" tillsammans med inställningen detachOption: "ForceDetach".
DiskEncryptionSetParameters	Anger resurs-ID för kundhanterad diskkrypteringsuppsättning för den hanterade disken.
DiskEncryptionSettings	Anger krypteringsinställningarna för OS-disken. Lägsta API-version: 2015-06-15.
ImageReference	Anger information om den avbildning som ska användas. Du kan ange information om plattformsbilder, marketplace-avbildningar eller avbildningar av virtuella datorer. Det här elementet krävs när du vill använda en plattformsbild, marketplace-avbildning eller virtuell datorbild, men inte används i andra skapandeåtgärder.
InnerError	Inre felinformation.
KeyVaultKeyReference	Anger platsen för nyckelkrypteringsnyckeln i Key Vault.
KeyVaultSecretReference	Anger platsen för diskkrypteringsnyckeln, som är en Nyckelvalvshemlighet.
ManagedDiskParameters	Parametrarna för hanterade diskar.
OperatingSystemTypes	Typ av operativsystem.
OSDisk	Anger information om den operativsystemdisk som används av den virtuella datorn. Mer information om diskar finns i Om diskar och virtuella hårddiskar för virtuella Azure-datorer.
securityEncryptionTypes	Anger EncryptionType för den hanterade disken. Den är inställd på DiskWithVMGuestState för kryptering av den hanterade disken tillsammans med VMGuestState-blob, VMGuestStateOnly för kryptering av bara VMGuestState-bloben och NonPersistedTPM för att inte bevara tillståndet för inbyggd programvara i VMGuestState-bloben. Obs! Det kan endast anges för konfidentiella virtuella datorer.
StorageAccountTypes	Anger lagringskontotypen för den hanterade disken. Obs! UltraSSD_LRS endast kan användas med datadiskar kan den inte användas med OS-disk.
StorageProfile	Anger lagringsinställningarna för de virtuella datordiskarna.
SubResource
VirtualHardDisk	Den virtuella hårddisken.
VMDiskSecurityProfile	Anger säkerhetsprofilen för den hanterade disken.

ApiEntityReference

Källresursidentifieraren. Det kan vara en ögonblicksbild eller en diskåterställningspunkt för att skapa en disk.

Name	Typ	Description
id	string	ARM-resurs-ID i form av /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Api-fel.

Name	Typ	Description
code	string	Felkoden.
details	ApiErrorBase[]	Api-felinformationen
innererror	InnerError	Api:ets inre fel
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

ApiErrorBase

Api-felbas.

Name	Typ	Description
code	string	Felkoden.
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

AttachDetachDataDisksRequest

Parametrar som tillhandahålls för att koppla och koppla från datadiskar på den virtuella datorn.

Name	Typ	Description
dataDisksToAttach	DataDisksToAttach[]	Listan över hanterade datadiskar som ska kopplas.
dataDisksToDetach	DataDisksToDetach[]	Listan över hanterade datadiskar som ska kopplas från.

CachingTypes

Anger cachelagringskraven. Möjliga värden är: Ingen,ReadOnlyReadWrite. Standardbeteendet är: Ingen för standardlagring. ReadOnly för Premium Storage.

Name	Typ	Description
None	string
ReadOnly	string
ReadWrite	string

CloudError

Ett felsvar från Compute-tjänsten.

Name	Typ	Description
error	ApiError	Api-fel.

DataDisk

Anger de parametrar som används för att lägga till en datadisk till en virtuell dator. Mer information om diskar finns i Om diskar och virtuella hårddiskar för virtuella Azure-datorer.

Name	Typ	Description
caching	CachingTypes	Anger cachelagringskraven. Möjliga värden är: Ingen,ReadOnlyReadWrite. Standardbeteendet är: Ingen för standardlagring. ReadOnly för Premium Storage.
createOption	DiskCreateOptionTypes	Anger hur den virtuella datordisken ska skapas. Möjliga värden är Bifoga: Det här värdet används när du använder en specialiserad disk för att skapa den virtuella datorn. FromImage: Det här värdet används när du använder en avbildning för att skapa datadisken för den virtuella datorn. Om du använder en plattformsavbildning bör du också använda imageReference-elementet som beskrivs ovan. Om du använder en Marketplace-avbildning bör du också använda det planelement som beskrevs tidigare. Tom: Det här värdet används när du skapar en tom datadisk. Kopiera: Det här värdet används för att skapa en datadisk från en ögonblicksbild eller en annan disk. Återställ: Det här värdet används för att skapa en datadisk från en diskåterställningspunkt.
deleteOption	DiskDeleteOptionTypes	Anger om datadisken ska tas bort eller kopplas från vid borttagning av virtuella datorer. Möjliga värden är: Ta bort. Om det här värdet används tas datadisken bort när den virtuella datorn tas bort. Lösgöra. Om det här värdet används behålls datadisken när den virtuella datorn har tagits bort. Standardvärdet är inställt på Koppla från.
detachOption	DiskDetachOptionTypes	Anger det frånkopplingsbeteende som ska användas när en disk kopplas från eller som redan håller på att kopplas från från den virtuella datorn. Värden som stöds: ForceDetach. detachOption: ForceDetach gäller endast för hanterade datadiskar. Om ett tidigare frånkopplingsförsök av datadisken inte slutfördes på grund av ett oväntat fel från den virtuella datorn och disken fortfarande inte har släppts använder du force-detach som ett sista utvägsalternativ för att koppla från disken med två våld från den virtuella datorn. Alla skrivningar kanske inte har tömts när du använder det här frånkopplingsbeteendet. För att tvinga bort en datadiskuppdatering tillBeDetached till "true" tillsammans med inställningen detachOption: "ForceDetach".
diskIOPSReadWrite	integer	Anger Read-Write IOPS för den hanterade disken när StorageAccountType UltraSSD_LRS. Returneras endast för virtuella VirtualMachine ScaleSet VM-diskar. Kan endast uppdateras via uppdateringar av VirtualMachine-skalningsuppsättningen.
diskMBpsReadWrite	integer	Anger bandbredden i MB per sekund för den hanterade disken när StorageAccountType UltraSSD_LRS. Returneras endast för virtuella VirtualMachine ScaleSet VM-diskar. Kan endast uppdateras via uppdateringar av VirtualMachine-skalningsuppsättningen.
diskSizeGB	integer	Anger storleken på en tom datadisk i gigabyte. Det här elementet kan användas för att skriva över storleken på disken i en virtuell datorbild. Egenskapen "diskSizeGB" är antalet byte x 1024^3 för disken och värdet får inte vara större än 1023.
image	VirtualHardDisk	Den virtuella hårddisken för källanvändarens avbildning. Den virtuella hårddisken kopieras innan den ansluts till den virtuella datorn. Om SourceImage tillhandahålls får den virtuella målhårdenheten inte finnas.
lun	integer	Anger datadiskens logiska enhetsnummer. Det här värdet används för att identifiera datadiskar i den virtuella datorn och måste därför vara unikt för varje datadisk som är ansluten till en virtuell dator.
managedDisk	ManagedDiskParameters	Parametrarna för hanterade diskar.
name	string	Disknamnet.
sourceResource	ApiEntityReference	Källresursidentifieraren. Det kan vara en ögonblicksbild eller en diskåterställningspunkt för att skapa en disk.
toBeDetached	boolean	Anger om datadisken håller på att kopplas från VirtualMachine/VirtualMachineScaleset
vhd	VirtualHardDisk	Den virtuella hårddisken.
writeAcceleratorEnabled	boolean	Anger om writeAccelerator ska aktiveras eller inaktiveras på disken.

DataDisksToAttach

Listan över hanterade datadiskar som ska kopplas.

Name	Typ	Description
caching	CachingTypes	Anger cachelagringskraven. Möjliga värden är: Ingen,ReadOnlyReadWrite. Standardbeteendet är: Ingen för standardlagring. ReadOnly för Premium Storage.
deleteOption	DiskDeleteOptionTypes	Anger om datadisken ska tas bort eller kopplas från vid borttagning av virtuella datorer. Möjliga värden är: Ta bort. Om det här värdet används tas datadisken bort när den virtuella datorn tas bort. Lösgöra. Om det här värdet används behålls datadisken när den virtuella datorn har tagits bort. Standardvärdet är inställt på Koppla från.
diskEncryptionSet	DiskEncryptionSetParameters	Anger resurs-ID för kundhanterad diskkrypteringsuppsättning för den hanterade disken.
diskId	string	ID för den hanterade datadisken.
lun	integer	Datadiskens logiska enhetsnummer. Det här värdet används för att identifiera datadiskar i den virtuella datorn och måste därför vara unikt för varje datadisk som är ansluten till en virtuell dator. Om det inte anges tilldelas lun automatiskt.
writeAcceleratorEnabled	boolean	Anger om writeAccelerator ska aktiveras eller inaktiveras på disken.

DataDisksToDetach

Listan över hanterade datadiskar som ska kopplas från.

Name	Typ	Description
detachOption	DiskDetachOptionTypes	Tillgängliga alternativ som stöds för Att koppla från en disk från en virtuell dator. Mer information finns i Referens för DetachOption-objekt.
diskId	string	ID för den hanterade datadisken.

DiffDiskOptions

Anger tillfälliga diskinställningar för operativsystemdisken.

Name	Typ	Description
Local	string

DiffDiskPlacement

Anger den tillfälliga diskplaceringen för operativsystemdisken. Möjliga värden är: CacheDisk,ResourceDiskNvmeDisk. Standardbeteendet är: CacheDisk om en har konfigurerats för den virtuella datorns storlek, annars används ResourceDisk eller NvmeDisk. Se dokumentationen om VM-storlek för virtuella Windows-datorer på https://docs.microsoft.com/azure/virtual-machines/windows/sizes och virtuell Linux-dator på https://docs.microsoft.com/azure/virtual-machines/linux/sizes för att kontrollera vilka VM-storlekar som exponerar en cachedisk. Lägsta api-version för NvmeDisk: 2024-03-01.

Name	Typ	Description
CacheDisk	string
NvmeDisk	string
ResourceDisk	string

DiffDiskSettings

Anger tillfälliga diskinställningar för den operativsystemdisk som används av den virtuella datorn.

Name	Typ	Description
option	DiffDiskOptions	Anger tillfälliga diskinställningar för operativsystemdisken.
placement	DiffDiskPlacement	Anger den tillfälliga diskplaceringen för operativsystemdisken. Möjliga värden är: CacheDisk,ResourceDiskNvmeDisk. Standardbeteendet är: CacheDisk om en har konfigurerats för den virtuella datorns storlek, annars används ResourceDisk eller NvmeDisk. Se dokumentationen om VM-storlek för virtuella Windows-datorer på https://docs.microsoft.com/azure/virtual-machines/windows/sizes och virtuell Linux-dator på https://docs.microsoft.com/azure/virtual-machines/linux/sizes för att kontrollera vilka VM-storlekar som exponerar en cachedisk. Lägsta api-version för NvmeDisk: 2024-03-01.

DiskControllerTypes

Anger vilken typ av diskkontrollant som konfigurerats för den virtuella datorn. Obs! Den här egenskapen anges till standardtypen för diskkontrollanten om den inte anges, förutsatt att den virtuella datorn skapas med "hyperVGeneration" inställt på V2 baserat på funktionerna för operativsystemdisken och VM-storleken från den angivna lägsta API-versionen. Du måste frigöra den virtuella datorn innan du uppdaterar dess typ av diskkontrollant såvida du inte uppdaterar vm-storleken i VM-konfigurationen som implicit frigör och omallokerar den virtuella datorn. Lägsta API-version: 2022-08-01.

Name	Typ	Description
NVMe	string
SCSI	string

DiskCreateOptionTypes

Anger hur den virtuella datordisken ska skapas. Möjliga värden är Bifoga: Det här värdet används när du använder en specialiserad disk för att skapa den virtuella datorn. FromImage: Det här värdet används när du använder en avbildning för att skapa den virtuella datorn. Om du använder en plattformsavbildning bör du också använda imageReference-elementet som beskrivs ovan. Om du använder en Marketplace-avbildning bör du också använda det planelement som beskrevs tidigare.

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

DiskDeleteOptionTypes

Anger om OS-disken ska tas bort eller kopplas från när den virtuella datorn tas bort. Möjliga värden är: Ta bort. Om det här värdet används tas OS-disken bort när den virtuella datorn tas bort. Lösgöra. Om det här värdet används behålls os-disken när den virtuella datorn har tagits bort. Standardvärdet är inställt på Koppla från. För en tillfällig OS-disk är standardvärdet inställt på Ta bort. Användaren kan inte ändra borttagningsalternativet för en tillfällig OS-disk.

Name	Typ	Description
Delete	string
Detach	string

DiskDetachOptionTypes

Anger det frånkopplingsbeteende som ska användas när en disk kopplas från eller som redan håller på att kopplas från från den virtuella datorn. Värden som stöds: ForceDetach. detachOption: ForceDetach gäller endast för hanterade datadiskar. Om ett tidigare frånkopplingsförsök av datadisken inte slutfördes på grund av ett oväntat fel från den virtuella datorn och disken fortfarande inte har släppts använder du force-detach som ett sista utvägsalternativ för att koppla från disken med två våld från den virtuella datorn. Alla skrivningar kanske inte har tömts när du använder det här frånkopplingsbeteendet. För att tvinga bort en datadiskuppdatering tillBeDetached till "true" tillsammans med inställningen detachOption: "ForceDetach".

Name	Typ	Description
ForceDetach	string

DiskEncryptionSetParameters

Anger resurs-ID för kundhanterad diskkrypteringsuppsättning för den hanterade disken.

Name	Typ	Description
id	string	Resurs-ID

DiskEncryptionSettings

Anger krypteringsinställningarna för OS-disken. Lägsta API-version: 2015-06-15.

Name	Typ	Description
diskEncryptionKey	KeyVaultSecretReference	Anger platsen för diskkrypteringsnyckeln, som är en Nyckelvalvshemlighet.
enabled	boolean	Anger om diskkryptering ska aktiveras på den virtuella datorn.
keyEncryptionKey	KeyVaultKeyReference	Anger platsen för nyckelkrypteringsnyckeln i Key Vault.

ImageReference

Anger information om den avbildning som ska användas. Du kan ange information om plattformsbilder, marketplace-avbildningar eller avbildningar av virtuella datorer. Det här elementet krävs när du vill använda en plattformsbild, marketplace-avbildning eller virtuell datorbild, men inte används i andra skapandeåtgärder.

Name	Typ	Description
communityGalleryImageId	string	Angav communitygalleriets unika ID för vm-distribution. Det här kan hämtas från get-anropet för communitygalleribilden.
exactVersion	string	Anger i decimaltal, vilken version av plattformsbild eller marketplace-avbildning som används för att skapa den virtuella datorn. Det här skrivskyddade fältet skiljer sig från "version", endast om värdet som anges i fältet "version" är "senaste".
id	string	Resurs-ID
offer	string	Anger erbjudandet för plattformsbilden eller marketplace-avbildningen som används för att skapa den virtuella datorn.
publisher	string	Bildutgivaren.
sharedGalleryImageId	string	Angav det unika ID:t för den delade galleriavbildningen för vm-distribution. Detta kan hämtas från get-anropet för den delade galleribilden.
sku	string	Avbildnings-SKU:n.
version	string	Anger vilken version av plattformsbilden eller marketplace-avbildningen som används för att skapa den virtuella datorn. De tillåtna formaten är Major.Minor.Build eller "latest". Major, Minor och Build är decimaltal. Ange "senaste" för att använda den senaste versionen av en avbildning som är tillgänglig vid distributionstillfället. Även om du använder "senaste" uppdateras inte den virtuella datoravbildningen automatiskt efter distributionstiden även om en ny version blir tillgänglig. Använd inte fältet "version" för distribution av galleribilder. Galleribild bör alltid använda id-fältet för distribution, för att använda den senaste versionen av galleribilden, ange bara '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' i fältet "id" utan indata från versionen.

InnerError

Inre felinformation.

Name	Typ	Description
errordetail	string	Det interna felmeddelandet eller undantagsdumpen.
exceptiontype	string	Undantagstypen.

KeyVaultKeyReference

Anger platsen för nyckelkrypteringsnyckeln i Key Vault.

Name	Typ	Description
keyUrl	string	URL:en som refererar till en nyckelkrypteringsnyckel i Key Vault.
sourceVault	SubResource	Den relativa URL:en för nyckelvalvet som innehåller nyckeln.

KeyVaultSecretReference

Anger platsen för diskkrypteringsnyckeln, som är en Nyckelvalvshemlighet.

Name	Typ	Description
secretUrl	string	URL:en som refererar till en hemlighet i ett Nyckelvalv.
sourceVault	SubResource	Den relativa URL:en för nyckelvalvet som innehåller hemligheten.

ManagedDiskParameters

Parametrarna för hanterade diskar.

Name	Typ	Description
diskEncryptionSet	DiskEncryptionSetParameters	Anger resurs-ID för kundhanterad diskkrypteringsuppsättning för den hanterade disken.
id	string	Resurs-ID
securityProfile	VMDiskSecurityProfile	Anger säkerhetsprofilen för den hanterade disken.
storageAccountType	StorageAccountTypes	Anger lagringskontotypen för den hanterade disken. Obs! UltraSSD_LRS endast kan användas med datadiskar kan den inte användas med OS-disk.

OperatingSystemTypes

Typ av operativsystem.

Name	Typ	Description
Linux	string
Windows	string

OSDisk

Anger information om den operativsystemdisk som används av den virtuella datorn. Mer information om diskar finns i Om diskar och virtuella hårddiskar för virtuella Azure-datorer.

Name	Typ	Description
caching	CachingTypes	Anger cachelagringskraven. Möjliga värden är: Ingen,ReadOnlyReadWrite. Standardbeteendet är: Ingen för standardlagring. ReadOnly för Premium Storage.
createOption	DiskCreateOptionTypes	Anger hur den virtuella datordisken ska skapas. Möjliga värden är Bifoga: Det här värdet används när du använder en specialiserad disk för att skapa den virtuella datorn. FromImage: Det här värdet används när du använder en avbildning för att skapa den virtuella datorn. Om du använder en plattformsavbildning bör du också använda imageReference-elementet som beskrivs ovan. Om du använder en Marketplace-avbildning bör du också använda det planelement som beskrevs tidigare.
deleteOption	DiskDeleteOptionTypes	Anger om OS-disken ska tas bort eller kopplas från när den virtuella datorn tas bort. Möjliga värden är: Ta bort. Om det här värdet används tas OS-disken bort när den virtuella datorn tas bort. Lösgöra. Om det här värdet används behålls os-disken när den virtuella datorn har tagits bort. Standardvärdet är inställt på Koppla från. För en tillfällig OS-disk är standardvärdet inställt på Ta bort. Användaren kan inte ändra borttagningsalternativet för en tillfällig OS-disk.
diffDiskSettings	DiffDiskSettings	Anger tillfälliga diskinställningar för den operativsystemdisk som används av den virtuella datorn.
diskSizeGB	integer	Anger storleken på en tom datadisk i gigabyte. Det här elementet kan användas för att skriva över storleken på disken i en virtuell datorbild. Egenskapen "diskSizeGB" är antalet byte x 1024^3 för disken och värdet får inte vara större än 1023.
encryptionSettings	DiskEncryptionSettings	Anger krypteringsinställningarna för OS-disken. Lägsta API-version: 2015-06-15.
image	VirtualHardDisk	Den virtuella hårddisken för källanvändarens avbildning. Den virtuella hårddisken kopieras innan den ansluts till den virtuella datorn. Om SourceImage tillhandahålls får den virtuella målhårdenheten inte finnas.
managedDisk	ManagedDiskParameters	Parametrarna för hanterade diskar.
name	string	Disknamnet.
osType	OperatingSystemTypes	Med den här egenskapen kan du ange vilken typ av operativsystem som ingår i disken om du skapar en virtuell dator från användaravbildning eller en specialiserad virtuell hårddisk. Möjliga värden är: Windows,Linux.
vhd	VirtualHardDisk	Den virtuella hårddisken.
writeAcceleratorEnabled	boolean	Anger om writeAccelerator ska aktiveras eller inaktiveras på disken.

securityEncryptionTypes

Anger EncryptionType för den hanterade disken. Den är inställd på DiskWithVMGuestState för kryptering av den hanterade disken tillsammans med VMGuestState-blob, VMGuestStateOnly för kryptering av bara VMGuestState-bloben och NonPersistedTPM för att inte bevara tillståndet för inbyggd programvara i VMGuestState-bloben. Obs! Det kan endast anges för konfidentiella virtuella datorer.

Name	Typ	Description
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

StorageAccountTypes

Anger lagringskontotypen för den hanterade disken. Obs! UltraSSD_LRS endast kan användas med datadiskar kan den inte användas med OS-disk.

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

StorageProfile

Anger lagringsinställningarna för de virtuella datordiskarna.

Name	Typ	Description
dataDisks	DataDisk[]	Anger de parametrar som används för att lägga till en datadisk till en virtuell dator. Mer information om diskar finns i Om diskar och virtuella hårddiskar för virtuella Azure-datorer.
diskControllerType	DiskControllerTypes	Anger vilken typ av diskkontrollant som konfigurerats för den virtuella datorn. Obs! Den här egenskapen anges till standardtypen för diskkontrollanten om den inte anges, förutsatt att den virtuella datorn skapas med "hyperVGeneration" inställt på V2 baserat på funktionerna för operativsystemdisken och VM-storleken från den angivna lägsta API-versionen. Du måste frigöra den virtuella datorn innan du uppdaterar dess typ av diskkontrollant såvida du inte uppdaterar vm-storleken i VM-konfigurationen som implicit frigör och omallokerar den virtuella datorn. Lägsta API-version: 2022-08-01.
imageReference	ImageReference	Anger information om den avbildning som ska användas. Du kan ange information om plattformsbilder, marketplace-avbildningar eller avbildningar av virtuella datorer. Det här elementet krävs när du vill använda en plattformsbild, marketplace-avbildning eller virtuell datorbild, men inte används i andra skapandeåtgärder.
osDisk	OSDisk	Anger information om den operativsystemdisk som används av den virtuella datorn. Mer information om diskar finns i Om diskar och virtuella hårddiskar för virtuella Azure-datorer.

SubResource

Name	Typ	Description
id	string	Resurs-ID

VirtualHardDisk

Den virtuella hårddisken.

Name	Typ	Description
uri	string	Anger den virtuella hårddiskens URI.

VMDiskSecurityProfile

Anger säkerhetsprofilen för den hanterade disken.

Name	Typ	Description
diskEncryptionSet	DiskEncryptionSetParameters	Anger resurs-ID för kundhanterad diskkrypteringsuppsättning för den hanterade disk som används för customer managed key encrypted ConfidentialVM OS Disk och VMGuest blob.
securityEncryptionType	securityEncryptionTypes	Anger EncryptionType för den hanterade disken. Den är inställd på DiskWithVMGuestState för kryptering av den hanterade disken tillsammans med VMGuestState-blob, VMGuestStateOnly för kryptering av bara VMGuestState-bloben och NonPersistedTPM för att inte bevara tillståndet för inbyggd programvara i VMGuestState-bloben. Obs! Det kan endast anges för konfidentiella virtuella datorer.