Virtual Machines - Attach Detach Data Disks

Služba:

Compute

Verze rozhraní API:

2024-07-01

Připojte a odpojte datové disky k nebo z virtuálního počítače.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
vmName	path	True	string	Název virtuálního počítače.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Typ	Description
parameters	AttachDetachDataDisksRequest	Parametry zadané pro operaci připojení a odpojení datových disků na virtuálním počítači

Odpovědi

Name	Typ	Description
200 OK	StorageProfile	OK
202 Accepted		Přijal Hlavičky Location: string
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

202

location: https://foo.com/operationstatus

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

202

location: https://foo.com/operationstatus

Definice

Name	Description
ApiEntityReference	Identifikátor zdrojového prostředku. Může to být snímek nebo bod obnovení disku, ze kterého se má vytvořit disk.
ApiError	Chyba rozhraní API
ApiErrorBase	Základ chyb rozhraní API.
AttachDetachDataDisksRequest	Parametry zadané pro operaci připojení a odpojení datových disků na virtuálním počítači
CachingTypes	Určuje požadavky na ukládání do mezipaměti. Možné hodnoty jsou: None,ReadOnly,ReadWrite. Výchozí chování je: Žádné pro úložiště úrovně Standard. Jen pro čtení pro Premium Storage.
CloudError	Odpověď na chybu z výpočetní služby
DataDisk	Určuje parametry, které se použijí k přidání datového disku do virtuálního počítače. Další informace o discích najdete v tématu Informace o discích a virtuálních pevných discích pro virtuální počítače Azure.
DataDisksToAttach	Seznam spravovaných datových disků, které se mají připojit.
DataDisksToDetach	Seznam spravovaných datových disků, které se mají odpojit.
DiffDiskOptions	Určuje dočasné nastavení disku pro disk operačního systému.
DiffDiskPlacement	Určuje dočasné umístění disku pro disk operačního systému. Možné hodnoty jsou: CacheDisk,ResourceDisk,NvmeDisk. Výchozí chování je: CacheDisk pokud je nakonfigurovaná pro velikost virtuálního počítače, jinak ResourceDisk nebo NvmeDisk. Informace o velikosti virtuálních počítačů najdete v dokumentaci k velikosti virtuálního počítače s Windows na https://docs.microsoft.com/azure/virtual-machines/windows/sizes a virtuálním počítači s Linuxem v https://docs.microsoft.com/azure/virtual-machines/linux/sizes a zkontrolujte, které velikosti virtuálních počítačů zpřístupňují disk mezipaměti. Minimální verze api pro NvmeDisk: 2024-03-01.
DiffDiskSettings	Určuje dočasné nastavení disku pro disk operačního systému používaný virtuálním počítačem.
DiskControllerTypes	Určuje typ řadiče disku nakonfigurovaného pro virtuální počítač. Poznámka: Tato vlastnost bude nastavena na výchozí typ řadiče disku, pokud není zadaný zadaný virtuální počítač s hyperVGeneration nastaveným na V2 na základě schopností disku operačního systému a velikosti virtuálního počítače ze zadané minimální verze rozhraní API. Před aktualizací typu řadiče disku musíte virtuální počítač uvolnit, pokud neaktualizujete velikost virtuálního počítače v konfiguraci virtuálního počítače, která tento virtuální počítač implicitně uvolní a relokuje. Minimální verze api: 2022-08-01.
DiskCreateOptionTypes	Určuje způsob vytvoření disku virtuálního počítače. Možné hodnoty jsou Attach: Tato hodnota se používá při použití specializovaného disku k vytvoření virtuálního počítače. FromImage: Tato hodnota se používá při použití image k vytvoření virtuálního počítače. Pokud používáte image platformy, měli byste také použít element imageReference popsaný výše. Pokud používáte image marketplace, měli byste také použít dříve popsaný prvek plánu.
DiskDeleteOptionTypes	Určuje, jestli se má disk s operačním systémem odstranit nebo odpojit po odstranění virtuálního počítače. Možné hodnoty jsou: Delete. Pokud se tato hodnota použije, disk s operačním systémem se odstraní při odstranění virtuálního počítače. Odpojit. Pokud se tato hodnota použije, disk s operačním systémem se zachovají po odstranění virtuálního počítače. Výchozí hodnota je nastavena na Odpojit. U dočasného disku s operačním systémem je výchozí hodnota nastavená na Odstranit. Uživatel nemůže změnit možnost odstranění dočasného disku s operačním systémem.
DiskDetachOptionTypes	Určuje chování odpojení, které se má použít při odpojení disku nebo které již probíhá v procesu odpojení od virtuálního počítače. Podporované hodnoty: ForceDetach. odpojení: ForceDetach platí jenom pro spravované datové disky. Pokud se předchozí pokus o odpojení datového disku nedokončil z důvodu neočekávaného selhání virtuálního počítače a disk se stále neuvolní, použijte možnost vynuceného odpojení jako poslední možnost odpojení disku od virtuálního počítače. Při použití tohoto chování odpojení nemusí být všechny zápisy vyprázdněny. Chcete-li vynutit odpojení datového disku aktualizace naBeDetached na true spolu s nastavením odpojeníOption: ForceDetach.
DiskEncryptionSetParameters	Určuje ID prostředku spravovaného disku spravovaného zákazníkem pro spravovaný disk.
DiskEncryptionSettings	Určuje nastavení šifrování disku s operačním systémem. Minimální verze api: 2015-06-15.
ImageReference	Určuje informace o obrázku, který se má použít. Můžete zadat informace o imagích platformy, imagích marketplace nebo imagích virtuálních počítačů. Tento prvek se vyžaduje, pokud chcete použít image platformy, image marketplace nebo image virtuálního počítače, ale nepoužívá se v jiných operacích vytváření.
InnerError	Podrobnosti vnitřní chyby.
KeyVaultKeyReference	Určuje umístění šifrovacího klíče klíče ve službě Key Vault.
KeyVaultSecretReference	Určuje umístění šifrovacího klíče disku, což je tajný klíč služby Key Vault.
ManagedDiskParameters	Parametry spravovaného disku.
OperatingSystemTypes	Typ operačního systému.
OSDisk	Určuje informace o disku operačního systému používaném virtuálním počítačem. Další informace o discích najdete v tématu Informace o discích a virtuálních pevných discích pro virtuální počítače Azure.
securityEncryptionTypes	Určuje Typ šifrování spravovaného disku. Je nastavena na DiskWithVMGuestState pro šifrování spravovaného disku spolu s objekty blob VMGuestState, VMGuestStateOnly pro šifrování pouze objektu blob VMGuestState a NonPersistedTPM pro neuchovávání stavu firmwaru v objektu blob VMGuestState. Poznámka: lze nastavit pouze pro důvěrné virtuální počítače.
StorageAccountTypes	Určuje typ účtu úložiště pro spravovaný disk. POZNÁMKA: UltraSSD_LRS lze použít pouze s datovými disky, nelze jej použít s diskem s operačním systémem.
StorageProfile	Určuje nastavení úložiště pro disky virtuálního počítače.
SubResource
VirtualHardDisk	Virtuální pevný disk.
VMDiskSecurityProfile	Určuje profil zabezpečení spravovaného disku.

ApiEntityReference

Identifikátor zdrojového prostředku. Může to být snímek nebo bod obnovení disku, ze kterého se má vytvořit disk.

Name	Typ	Description
id	string	ID prostředku ARM ve tvaru /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Chyba rozhraní API

Name	Typ	Description
code	string	Kód chyby.
details	ApiErrorBase[]	Podrobnosti o chybě rozhraní API
innererror	InnerError	Vnitřní chyba rozhraní API
message	string	Chybová zpráva.
target	string	Cíl konkrétní chyby.

ApiErrorBase

Základ chyb rozhraní API.

Name	Typ	Description
code	string	Kód chyby.
message	string	Chybová zpráva.
target	string	Cíl konkrétní chyby.

AttachDetachDataDisksRequest

Parametry zadané pro operaci připojení a odpojení datových disků na virtuálním počítači

Name	Typ	Description
dataDisksToAttach	DataDisksToAttach[]	Seznam spravovaných datových disků, které se mají připojit.
dataDisksToDetach	DataDisksToDetach[]	Seznam spravovaných datových disků, které se mají odpojit.

CachingTypes

Určuje požadavky na ukládání do mezipaměti. Možné hodnoty jsou: None,ReadOnly,ReadWrite. Výchozí chování je: Žádné pro úložiště úrovně Standard. Jen pro čtení pro Premium Storage.

Name	Typ	Description
None	string
ReadOnly	string
ReadWrite	string

CloudError

Odpověď na chybu z výpočetní služby

Name	Typ	Description
error	ApiError	Chyba rozhraní API

DataDisk

Určuje parametry, které se použijí k přidání datového disku do virtuálního počítače. Další informace o discích najdete v tématu Informace o discích a virtuálních pevných discích pro virtuální počítače Azure.

Name	Typ	Description
caching	CachingTypes	Určuje požadavky na ukládání do mezipaměti. Možné hodnoty jsou: None,ReadOnly,ReadWrite. Výchozí chování je: Žádné pro úložiště úrovně Standard. Jen pro čtení pro Premium Storage.
createOption	DiskCreateOptionTypes	Určuje způsob vytvoření disku virtuálního počítače. Možné hodnoty jsou Attach: Tato hodnota se používá při použití specializovaného disku k vytvoření virtuálního počítače. FromImage: Tato hodnota se používá při použití image k vytvoření datového disku virtuálního počítače. Pokud používáte image platformy, měli byste také použít element imageReference popsaný výše. Pokud používáte image marketplace, měli byste také použít dříve popsaný prvek plánu. Prázdné: Tato hodnota se používá při vytváření prázdného datového disku. Kopírovat: Tato hodnota slouží k vytvoření datového disku ze snímku nebo jiného disku. Obnovení: Tato hodnota slouží k vytvoření datového disku z bodu obnovení disku.
deleteOption	DiskDeleteOptionTypes	Určuje, jestli se má datový disk odstranit nebo odpojit po odstranění virtuálního počítače. Možné hodnoty jsou: Delete. Pokud se tato hodnota použije, datový disk se odstraní při odstranění virtuálního počítače. Odpojit. Pokud se tato hodnota použije, datový disk se zachovají po odstranění virtuálního počítače. Výchozí hodnota je nastavena na Odpojit.
detachOption	DiskDetachOptionTypes	Určuje chování odpojení, které se má použít při odpojení disku nebo které již probíhá v procesu odpojení od virtuálního počítače. Podporované hodnoty: ForceDetach. odpojení: ForceDetach platí jenom pro spravované datové disky. Pokud se předchozí pokus o odpojení datového disku nedokončil z důvodu neočekávaného selhání virtuálního počítače a disk se stále neuvolní, použijte možnost vynuceného odpojení jako poslední možnost odpojení disku od virtuálního počítače. Při použití tohoto chování odpojení nemusí být všechny zápisy vyprázdněny. Chcete-li vynutit odpojení datového disku aktualizace naBeDetached na true spolu s nastavením odpojeníOption: ForceDetach.
diskIOPSReadWrite	integer	Určuje Read-Write IOPS spravovaného disku, když je storageAccountType UltraSSD_LRS. Vráceno pouze pro disky virtuálních počítačů VirtualMachine ScaleSet. Je možné aktualizovat pouze prostřednictvím aktualizací škálovací sady VirtualMachine.
diskMBpsReadWrite	integer	Určuje šířku pásma v MB za sekundu pro spravovaný disk, když je storageAccountType UltraSSD_LRS. Vráceno pouze pro disky virtuálních počítačů VirtualMachine ScaleSet. Je možné aktualizovat pouze prostřednictvím aktualizací škálovací sady VirtualMachine.
diskSizeGB	integer	Určuje velikost prázdného datového disku v gigabajtech. Tento prvek lze použít k přepsání velikosti disku v imagi virtuálního počítače. Vlastnost diskSizeGB je počet bajtů x 1024^3 disku a hodnota nemůže být větší než 1023.
image	VirtualHardDisk	Virtuální pevný disk image zdrojového uživatele. Virtuální pevný disk se zkopíruje před tím, než se připojí k virtuálnímu počítači. Pokud je k dispozici sourceImage, cílový virtuální pevný disk nesmí existovat.
lun	integer	Určuje počet logických jednotek datového disku. Tato hodnota se používá k identifikaci datových disků v rámci virtuálního počítače, a proto musí být jedinečná pro každý datový disk připojený k virtuálnímu počítači.
managedDisk	ManagedDiskParameters	Parametry spravovaného disku.
name	string	Název disku.
sourceResource	ApiEntityReference	Identifikátor zdrojového prostředku. Může to být snímek nebo bod obnovení disku, ze kterého se má vytvořit disk.
toBeDetached	boolean	Určuje, jestli je datový disk v procesu odpojení od virtualMachine/VirtualMachineScaleset.
vhd	VirtualHardDisk	Virtuální pevný disk.
writeAcceleratorEnabled	boolean	Určuje, jestli má být na disku povolený nebo zakázaný writeAccelerator.

DataDisksToAttach

Seznam spravovaných datových disků, které se mají připojit.

Name	Typ	Description
caching	CachingTypes	Určuje požadavky na ukládání do mezipaměti. Možné hodnoty jsou: None,ReadOnly,ReadWrite. Výchozí chování je: Žádné pro úložiště úrovně Standard. Jen pro čtení pro Premium Storage.
deleteOption	DiskDeleteOptionTypes	Určuje, jestli se má datový disk odstranit nebo odpojit po odstranění virtuálního počítače. Možné hodnoty jsou: Delete. Pokud se tato hodnota použije, datový disk se odstraní při odstranění virtuálního počítače. Odpojit. Pokud se tato hodnota použije, datový disk se zachovají po odstranění virtuálního počítače. Výchozí hodnota je nastavena na Odpojit.
diskEncryptionSet	DiskEncryptionSetParameters	Určuje ID prostředku spravovaného disku spravovaného zákazníkem pro spravovaný disk.
diskId	string	ID spravovaného datového disku.
lun	integer	Počet logických jednotek datového disku. Tato hodnota se používá k identifikaci datových disků v rámci virtuálního počítače, a proto musí být jedinečná pro každý datový disk připojený k virtuálnímu počítači. Pokud ho nezadáte, bude automaticky přiřazena logická jednotka.
writeAcceleratorEnabled	boolean	Určuje, jestli má být na disku povolený nebo zakázaný writeAccelerator.

DataDisksToDetach

Seznam spravovaných datových disků, které se mají odpojit.

Name	Typ	Description
detachOption	DiskDetachOptionTypes	Podporované možnosti pro odpojení disku z virtuálního počítače Další podrobnosti najdete v referenčních informacích k objektu DetachOption.
diskId	string	ID spravovaného datového disku.

DiffDiskOptions

Určuje dočasné nastavení disku pro disk operačního systému.

Name	Typ	Description
Local	string

DiffDiskPlacement

Určuje dočasné umístění disku pro disk operačního systému. Možné hodnoty jsou: CacheDisk,ResourceDisk,NvmeDisk. Výchozí chování je: CacheDisk pokud je nakonfigurovaná pro velikost virtuálního počítače, jinak ResourceDisk nebo NvmeDisk. Informace o velikosti virtuálních počítačů najdete v dokumentaci k velikosti virtuálního počítače s Windows na https://docs.microsoft.com/azure/virtual-machines/windows/sizes a virtuálním počítači s Linuxem v https://docs.microsoft.com/azure/virtual-machines/linux/sizes a zkontrolujte, které velikosti virtuálních počítačů zpřístupňují disk mezipaměti. Minimální verze api pro NvmeDisk: 2024-03-01.

Name	Typ	Description
CacheDisk	string
NvmeDisk	string
ResourceDisk	string

DiffDiskSettings

Určuje dočasné nastavení disku pro disk operačního systému používaný virtuálním počítačem.

Name	Typ	Description
option	DiffDiskOptions	Určuje dočasné nastavení disku pro disk operačního systému.
placement	DiffDiskPlacement	Určuje dočasné umístění disku pro disk operačního systému. Možné hodnoty jsou: CacheDisk,ResourceDisk,NvmeDisk. Výchozí chování je: CacheDisk pokud je nakonfigurovaná pro velikost virtuálního počítače, jinak ResourceDisk nebo NvmeDisk. Informace o velikosti virtuálních počítačů najdete v dokumentaci k velikosti virtuálního počítače s Windows na https://docs.microsoft.com/azure/virtual-machines/windows/sizes a virtuálním počítači s Linuxem v https://docs.microsoft.com/azure/virtual-machines/linux/sizes a zkontrolujte, které velikosti virtuálních počítačů zpřístupňují disk mezipaměti. Minimální verze api pro NvmeDisk: 2024-03-01.

DiskControllerTypes

Určuje typ řadiče disku nakonfigurovaného pro virtuální počítač. Poznámka: Tato vlastnost bude nastavena na výchozí typ řadiče disku, pokud není zadaný zadaný virtuální počítač s hyperVGeneration nastaveným na V2 na základě schopností disku operačního systému a velikosti virtuálního počítače ze zadané minimální verze rozhraní API. Před aktualizací typu řadiče disku musíte virtuální počítač uvolnit, pokud neaktualizujete velikost virtuálního počítače v konfiguraci virtuálního počítače, která tento virtuální počítač implicitně uvolní a relokuje. Minimální verze api: 2022-08-01.

Name	Typ	Description
NVMe	string
SCSI	string

DiskCreateOptionTypes

Určuje způsob vytvoření disku virtuálního počítače. Možné hodnoty jsou Attach: Tato hodnota se používá při použití specializovaného disku k vytvoření virtuálního počítače. FromImage: Tato hodnota se používá při použití image k vytvoření virtuálního počítače. Pokud používáte image platformy, měli byste také použít element imageReference popsaný výše. Pokud používáte image marketplace, měli byste také použít dříve popsaný prvek plánu.

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

DiskDeleteOptionTypes

Určuje, jestli se má disk s operačním systémem odstranit nebo odpojit po odstranění virtuálního počítače. Možné hodnoty jsou: Delete. Pokud se tato hodnota použije, disk s operačním systémem se odstraní při odstranění virtuálního počítače. Odpojit. Pokud se tato hodnota použije, disk s operačním systémem se zachovají po odstranění virtuálního počítače. Výchozí hodnota je nastavena na Odpojit. U dočasného disku s operačním systémem je výchozí hodnota nastavená na Odstranit. Uživatel nemůže změnit možnost odstranění dočasného disku s operačním systémem.

Name	Typ	Description
Delete	string
Detach	string

DiskDetachOptionTypes

Určuje chování odpojení, které se má použít při odpojení disku nebo které již probíhá v procesu odpojení od virtuálního počítače. Podporované hodnoty: ForceDetach. odpojení: ForceDetach platí jenom pro spravované datové disky. Pokud se předchozí pokus o odpojení datového disku nedokončil z důvodu neočekávaného selhání virtuálního počítače a disk se stále neuvolní, použijte možnost vynuceného odpojení jako poslední možnost odpojení disku od virtuálního počítače. Při použití tohoto chování odpojení nemusí být všechny zápisy vyprázdněny. Chcete-li vynutit odpojení datového disku aktualizace naBeDetached na true spolu s nastavením odpojeníOption: ForceDetach.

Name	Typ	Description
ForceDetach	string

DiskEncryptionSetParameters

Určuje ID prostředku spravovaného disku spravovaného zákazníkem pro spravovaný disk.

Name	Typ	Description
id	string	ID prostředku

DiskEncryptionSettings

Určuje nastavení šifrování disku s operačním systémem. Minimální verze api: 2015-06-15.

Name	Typ	Description
diskEncryptionKey	KeyVaultSecretReference	Určuje umístění šifrovacího klíče disku, což je tajný klíč služby Key Vault.
enabled	boolean	Určuje, jestli má být na virtuálním počítači povolené šifrování disku.
keyEncryptionKey	KeyVaultKeyReference	Určuje umístění šifrovacího klíče klíče ve službě Key Vault.

ImageReference

Určuje informace o obrázku, který se má použít. Můžete zadat informace o imagích platformy, imagích marketplace nebo imagích virtuálních počítačů. Tento prvek se vyžaduje, pokud chcete použít image platformy, image marketplace nebo image virtuálního počítače, ale nepoužívá se v jiných operacích vytváření.

Name	Typ	Description
communityGalleryImageId	string	Zadali jsme jedinečné ID image galerie komunity pro nasazení virtuálního počítače. To se dá načíst z volání GET galerie komunity.
exactVersion	string	Určuje desetinná čísla, verzi image platformy nebo image marketplace použitou k vytvoření virtuálního počítače. Toto pole jen pro čtení se liší od "verze", pouze pokud je hodnota zadaná v poli verze "latest".
id	string	ID prostředku
offer	string	Určuje nabídku image platformy nebo image marketplace použité k vytvoření virtuálního počítače.
publisher	string	Vydavatel image.
sharedGalleryImageId	string	Zadali jste jedinečné ID image sdílené galerie pro nasazení virtuálního počítače. To se dá načíst z volání GET sdíleného obrázku galerie.
sku	string	Skladová položka image.
version	string	Určuje verzi image platformy nebo image marketplace, která se používá k vytvoření virtuálního počítače. Povolené formáty jsou Major.Minor.Build nebo Latest. Hlavní, Vedlejší a Build jsou desetinná čísla. Zadejte nejnovější verzi image, která je k dispozici v době nasazení. I když použijete nejnovější verzi, image virtuálního počítače se po nasazení automaticky neaktualizuje, i když bude k dispozici nová verze. Nepoužívejte pole Verze pro nasazení imagí galerie, image galerie by pro nasazení měla vždy používat pole ID, pokud chcete použít nejnovější verzi image galerie, stačí nastavit /subscriptions/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageName} v poli ID bez zadání verze.

InnerError

Podrobnosti vnitřní chyby.

Name	Typ	Description
errordetail	string	Vnitřní chybová zpráva nebo výpis výjimky.
exceptiontype	string	Typ výjimky.

KeyVaultKeyReference

Určuje umístění šifrovacího klíče klíče ve službě Key Vault.

Name	Typ	Description
keyUrl	string	Adresa URL odkazující na šifrovací klíč klíče ve službě Key Vault.
sourceVault	SubResource	Relativní adresa URL služby Key Vault obsahující klíč.

KeyVaultSecretReference

Určuje umístění šifrovacího klíče disku, což je tajný klíč služby Key Vault.

Name	Typ	Description
secretUrl	string	Adresa URL odkazující na tajný kód ve službě Key Vault.
sourceVault	SubResource	Relativní adresa URL služby Key Vault obsahující tajný klíč.

ManagedDiskParameters

Parametry spravovaného disku.

Name	Typ	Description
diskEncryptionSet	DiskEncryptionSetParameters	Určuje ID prostředku spravovaného disku spravovaného zákazníkem pro spravovaný disk.
id	string	ID prostředku
securityProfile	VMDiskSecurityProfile	Určuje profil zabezpečení spravovaného disku.
storageAccountType	StorageAccountTypes	Určuje typ účtu úložiště pro spravovaný disk. POZNÁMKA: UltraSSD_LRS lze použít pouze s datovými disky, nelze jej použít s diskem s operačním systémem.

OperatingSystemTypes

Typ operačního systému.

Name	Typ	Description
Linux	string
Windows	string

OSDisk

Určuje informace o disku operačního systému používaném virtuálním počítačem. Další informace o discích najdete v tématu Informace o discích a virtuálních pevných discích pro virtuální počítače Azure.

Name	Typ	Description
caching	CachingTypes	Určuje požadavky na ukládání do mezipaměti. Možné hodnoty jsou: None,ReadOnly,ReadWrite. Výchozí chování je: Žádné pro úložiště úrovně Standard. Jen pro čtení pro Premium Storage.
createOption	DiskCreateOptionTypes	Určuje způsob vytvoření disku virtuálního počítače. Možné hodnoty jsou Attach: Tato hodnota se používá při použití specializovaného disku k vytvoření virtuálního počítače. FromImage: Tato hodnota se používá při použití image k vytvoření virtuálního počítače. Pokud používáte image platformy, měli byste také použít element imageReference popsaný výše. Pokud používáte image marketplace, měli byste také použít dříve popsaný prvek plánu.
deleteOption	DiskDeleteOptionTypes	Určuje, jestli se má disk s operačním systémem odstranit nebo odpojit po odstranění virtuálního počítače. Možné hodnoty jsou: Delete. Pokud se tato hodnota použije, disk s operačním systémem se odstraní při odstranění virtuálního počítače. Odpojit. Pokud se tato hodnota použije, disk s operačním systémem se zachovají po odstranění virtuálního počítače. Výchozí hodnota je nastavena na Odpojit. U dočasného disku s operačním systémem je výchozí hodnota nastavená na Odstranit. Uživatel nemůže změnit možnost odstranění dočasného disku s operačním systémem.
diffDiskSettings	DiffDiskSettings	Určuje dočasné nastavení disku pro disk operačního systému používaný virtuálním počítačem.
diskSizeGB	integer	Určuje velikost prázdného datového disku v gigabajtech. Tento prvek lze použít k přepsání velikosti disku v imagi virtuálního počítače. Vlastnost diskSizeGB je počet bajtů x 1024^3 disku a hodnota nemůže být větší než 1023.
encryptionSettings	DiskEncryptionSettings	Určuje nastavení šifrování disku s operačním systémem. Minimální verze api: 2015-06-15.
image	VirtualHardDisk	Virtuální pevný disk image zdrojového uživatele. Virtuální pevný disk se zkopíruje před tím, než se připojí k virtuálnímu počítači. Pokud je k dispozici sourceImage, cílový virtuální pevný disk nesmí existovat.
managedDisk	ManagedDiskParameters	Parametry spravovaného disku.
name	string	Název disku.
osType	OperatingSystemTypes	Tato vlastnost umožňuje určit typ operačního systému, který je součástí disku při vytváření virtuálního počítače z image uživatele nebo specializovaného virtuálního pevného disku. Možné hodnoty jsou: Windows,Linux.
vhd	VirtualHardDisk	Virtuální pevný disk.
writeAcceleratorEnabled	boolean	Určuje, jestli má být na disku povolený nebo zakázaný writeAccelerator.

securityEncryptionTypes

Určuje Typ šifrování spravovaného disku. Je nastavena na DiskWithVMGuestState pro šifrování spravovaného disku spolu s objekty blob VMGuestState, VMGuestStateOnly pro šifrování pouze objektu blob VMGuestState a NonPersistedTPM pro neuchovávání stavu firmwaru v objektu blob VMGuestState. Poznámka: lze nastavit pouze pro důvěrné virtuální počítače.

Name	Typ	Description
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

StorageAccountTypes

Určuje typ účtu úložiště pro spravovaný disk. POZNÁMKA: UltraSSD_LRS lze použít pouze s datovými disky, nelze jej použít s diskem s operačním systémem.

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

Určuje nastavení úložiště pro disky virtuálního počítače.

Name	Typ	Description
dataDisks	DataDisk[]	Určuje parametry, které se použijí k přidání datového disku do virtuálního počítače. Další informace o discích najdete v tématu Informace o discích a virtuálních pevných discích pro virtuální počítače Azure.
diskControllerType	DiskControllerTypes	Určuje typ řadiče disku nakonfigurovaného pro virtuální počítač. Poznámka: Tato vlastnost bude nastavena na výchozí typ řadiče disku, pokud není zadaný zadaný virtuální počítač s hyperVGeneration nastaveným na V2 na základě schopností disku operačního systému a velikosti virtuálního počítače ze zadané minimální verze rozhraní API. Před aktualizací typu řadiče disku musíte virtuální počítač uvolnit, pokud neaktualizujete velikost virtuálního počítače v konfiguraci virtuálního počítače, která tento virtuální počítač implicitně uvolní a relokuje. Minimální verze api: 2022-08-01.
imageReference	ImageReference	Určuje informace o obrázku, který se má použít. Můžete zadat informace o imagích platformy, imagích marketplace nebo imagích virtuálních počítačů. Tento prvek se vyžaduje, pokud chcete použít image platformy, image marketplace nebo image virtuálního počítače, ale nepoužívá se v jiných operacích vytváření.
osDisk	OSDisk	Určuje informace o disku operačního systému používaném virtuálním počítačem. Další informace o discích najdete v tématu Informace o discích a virtuálních pevných discích pro virtuální počítače Azure.

SubResource

Name	Typ	Description
id	string	ID prostředku

VirtualHardDisk

Virtuální pevný disk.

Name	Typ	Description
uri	string	Určuje identifikátor URI virtuálního pevného disku.

VMDiskSecurityProfile

Určuje profil zabezpečení spravovaného disku.

Name	Typ	Description
diskEncryptionSet	DiskEncryptionSetParameters	Určuje ID prostředku sady prostředků spravovaného zákazníkem spravovaného disku pro spravovaný disk, který se používá pro šifrovaný disk s důvěrným operačním systémem důvěrného virtuálního počítače a objekt blob VMGuest.
securityEncryptionType	securityEncryptionTypes	Určuje Typ šifrování spravovaného disku. Je nastavena na DiskWithVMGuestState pro šifrování spravovaného disku spolu s objekty blob VMGuestState, VMGuestStateOnly pro šifrování pouze objektu blob VMGuestState a NonPersistedTPM pro neuchovávání stavu firmwaru v objektu blob VMGuestState. Poznámka: lze nastavit pouze pro důvěrné virtuální počítače.