Virtual Machine Scale Set VMs - Attach Detach Data Disks

Service:

Compute

API Version:

2024-03-01

Připojení a odpojení datových disků k virtuálnímu počítači ve škálovací sadě virtuálních počítačů

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
instanceId	path	True	string	ID instance virtuálního počítače.
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 je součástí identifikátoru URI pro každé volání služby.
vmScaleSetName	path	True	string	Název škálovací sady virtuálních počítačů.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

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

Odpovědi

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

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

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

Příklady

VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen

VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen

VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen

Sample Request

HTTP

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

{
  "dataDisksToAttach": [
    {
      "lun": 1,
      "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
      "diskEncryptionSet": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
      },
      "caching": "ReadOnly",
      "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",
      "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.DiskDetachOptionTypes;
import com.azure.resourcemanager.compute.models.DiskEncryptionSetParameters;
import java.util.Arrays;

/**
 * Samples for VirtualMachineScaleSetVMs AttachDetachDataDisks.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualMachineScaleSetVMAttachDetachDataDisksMaximumSetGen(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMs().attachDetachDataDisks(
            "rgcompute", "azure-vmscaleset", "0",
            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)
                .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)
                    .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 typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_scale_set_vm_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_machine_scale_set_vms.begin_attach_detach_data_disks(
        resource_group_name="rgcompute",
        vm_scale_set_name="azure-vmscaleset",
        instance_id="0",
        parameters={
            "dataDisksToAttach": [
                {
                    "caching": "ReadOnly",
                    "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",
                    "diskEncryptionSet": {
                        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
                    },
                    "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e",
                    "lun": 2,
                    "writeAcceleratorEnabled": False,
                },
            ],
            "dataDisksToDetach": [
                {
                    "detachOption": "ForceDetach",
                    "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x",
                },
                {
                    "detachOption": "ForceDetach",
                    "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_4_disk4_4d4e784bdafa49baa780eb2d256ff41z",
                },
            ],
        },
    ).result()
    print(response)


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

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

Go

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen.json
func ExampleVirtualMachineScaleSetVMsClient_BeginAttachDetachDataDisks_virtualMachineScaleSetVmAttachDetachDataDisksMaximumSetGen() {
	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.NewVirtualMachineScaleSetVMsClient().BeginAttachDetachDataDisks(ctx, "rgcompute", "azure-vmscaleset", "0", armcompute.AttachDetachDataDisksRequest{
		DataDisksToAttach: []*armcompute.DataDisksToAttach{
			{
				Caching: to.Ptr(armcompute.CachingTypesReadOnly),
				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),
				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),
	// 			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),
	// 			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 a virtual machine in a VM scale set.
 *
 * @summary Attach and detach data disks to/from a virtual machine in a VM scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen.json
 */
async function virtualMachineScaleSetVMAttachDetachDataDisksMaximumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const vmScaleSetName = "azure-vmscaleset";
  const instanceId = "0";
  const parameters = {
    dataDisksToAttach: [
      {
        caching: "ReadOnly",
        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",
        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.virtualMachineScaleSetVMs.beginAttachDetachDataDisksAndWait(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
    parameters,
  );
  console.log(result);
}

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

Sample Response

Status code:

200

location: https://foo.com/operationstatus

Response Body

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

Status code:

202

location: https://foo.com/operationstatus

VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen

Sample Request

HTTP

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

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

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 VirtualMachineScaleSetVMs AttachDetachDataDisks.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualMachineScaleSetVMAttachDetachDataDisksMinimumSetGen(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetVMs().attachDetachDataDisks(
            "rgcompute", "azure-vmscaleset", "0",
            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 typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_scale_set_vm_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_machine_scale_set_vms.begin_attach_detach_data_disks(
        resource_group_name="rgcompute",
        vm_scale_set_name="azure-vmscaleset",
        instance_id="0",
        parameters={
            "dataDisksToAttach": [
                {
                    "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"
                }
            ],
            "dataDisksToDetach": [
                {
                    "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x"
                }
            ],
        },
    ).result()
    print(response)


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

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

Go

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen.json
func ExampleVirtualMachineScaleSetVMsClient_BeginAttachDetachDataDisks_virtualMachineScaleSetVmAttachDetachDataDisksMinimumSetGen() {
	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.NewVirtualMachineScaleSetVMsClient().BeginAttachDetachDataDisks(ctx, "rgcompute", "azure-vmscaleset", "0", 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 a virtual machine in a VM scale set.
 *
 * @summary Attach and detach data disks to/from a virtual machine in a VM scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen.json
 */
async function virtualMachineScaleSetVMAttachDetachDataDisksMinimumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const vmScaleSetName = "azure-vmscaleset";
  const instanceId = "0";
  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.virtualMachineScaleSetVMs.beginAttachDetachDataDisksAndWait(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
    parameters,
  );
  console.log(result);
}

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

Sample Response

Status code:

200

location: https://foo.com/operationstatus

Response Body

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

Status code:

202

location: https://foo.com/operationstatus

Definice

Name	Description
ApiEntityReference	Identifikátor zdrojového prostředku. Může se jednat o snímek nebo bod obnovení disku, ze kterého chcete vytvořit disk.
ApiError	Chyba rozhraní API
ApiErrorBase	Základ chyb rozhraní API.
AttachDetachDataDisksRequest	Parametry zadané operaci připojení a odpojení datových disků na Virtual Machine Scale Sets 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. ReadOnly pro Premium Storage.
CloudError	Chybová odpověď ze služby Compute.
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 nastavení dočasného disku pro disk operačního systému.
DiffDiskPlacement	Určuje umístění dočasného disku pro disk s operačním systémem. 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 se použije ResourceDisk nebo NvmeDisk. Pokud chcete zjistit, které velikosti virtuálních počítačů zpřístupňují disk mezipaměti, 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 https://docs.microsoft.com/azure/virtual-machines/linux/sizes s Linuxem. Minimální verze rozhraní 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ý pro virtuální počítač. Poznámka: Tato vlastnost se nastaví na výchozí typ řadiče disku, pokud není zadána za předpokladu, že se virtuální počítač vytváří s hyperVGeneration nastavenou na hodnotu V2 na základě možností disku s operačním systémem a velikosti virtuálního počítače ze zadané minimální verze rozhraní API. Před aktualizací jeho typu řadiče disku je potřeba virtuální počítač uvolnit, pokud neaktualizujete velikost virtuálního počítače v konfiguraci virtuálního počítače, která implicitně zruší a přerozdělí virtuální počítač. Minimální verze api-version: 2022-08-01.
DiskCreateOptionTypes	Určuje způsob vytvoření disku virtuálního počítače. Možné hodnoty jsou Připojit: Tato hodnota se používá, když k vytvoření virtuálního počítače používáte specializovaný disk. FromImage: Tato hodnota se používá, když k vytvoření virtuálního počítače používáte image. Pokud používáte image platformy, měli byste také použít element imageReference popsaný výše. Pokud používáte image z marketplace, měli byste také použít dříve popsaný element plánu.
DiskDeleteOptionTypes	Určuje, jestli se má při odstranění virtuálního počítače odstranit nebo odpojit disk s operačním systémem. Možné hodnoty jsou: Delete. Pokud se použije tato hodnota, disk s operačním systémem se při odstranění virtuálního počítače odstraní. Odpojit. Pokud se použije tato hodnota, disk s operačním systémem se zachová i po odstranění virtuálního počítače. Výchozí hodnota je nastavená 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í při odpojování, které se má použít při odpojování disku nebo které již probíhá v procesu odpojování od virtuálního počítače. Podporované hodnoty: ForceDetach. detachOption: ForceDetach se dá použít jenom pro spravované datové disky. Pokud se předchozí pokus o odpojení datového disku nedokončil kvůli neočekávanému selhání virtuálního počítače a disk stále není uvolněný, použijte vynucené odpojení jako poslední možnost k vynucení odpojení disku od virtuálního počítače. Při použití tohoto chování při odpojení nemusí být vyprázdněny všechny zápisy. Tato funkce je stále v režimu preview a virtualMachineScaleSet se nepodporuje. Pokud chcete vynutit odpojení datového disku, aktualizujte na hodnotuBeDetached na true spolu s nastavením detachOption: ForceDetach.
DiskEncryptionSetParameters	Určuje ID prostředku sady šifrování disků spravovaných zákazníkem pro spravovaný disk.
DiskEncryptionSettings	Určuje nastavení šifrování disku s operačním systémem. Minimální verze api-version: 2015-06-15.
ImageReference	Určuje informace o obrázku, který se má použít. Můžete zadat informace o imagích platforem, 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 o vnitřní chybě.
KeyVaultKeyReference	Určuje umístění šifrovacího klíče klíče v Key Vault.
KeyVaultSecretReference	Určuje umístění šifrovacího klíče disku, což je tajný klíč 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 nastavená na DiskWithVMGuestState pro šifrování spravovaného disku spolu s objektem blob VMGuestState, VMGuestStateOnly pro šifrování pouze objektu blob VMGuestState a NonPersistedTPM pro neuchovávání stavu firmwaru v objektu blob VMGuestState. Poznámka: Dá se nastavit jenom 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 ji 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 se jednat o snímek nebo bod obnovení disku, ze kterého chcete vytvořit disk.

Name	Typ	Description
id	string	ID prostředku ARM ve tvaru /subscriptions/{Id_předplatného}/resourceGroups/{název_skupiny_prostředků}/...

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é operaci připojení a odpojení datových disků na Virtual Machine Scale Sets 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. ReadOnly pro Premium Storage.

Name	Typ	Description
None	string
ReadOnly	string
ReadWrite	string

CloudError

Chybová odpověď ze služby Compute.

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. ReadOnly pro Premium Storage.
createOption	DiskCreateOptionTypes	Určuje způsob vytvoření disku virtuálního počítače. Možné hodnoty jsou Připojit: Tato hodnota se používá, když k vytvoření virtuálního počítače používáte specializovaný disk. FromImage: Tato hodnota se používá, když k vytvoření datového disku virtuálního počítače používáte image. Pokud používáte image platformy, měli byste také použít element imageReference popsaný výše. Pokud používáte image z marketplace, měli byste také použít dříve popsaný element plánu. Prázdné: Tato hodnota se používá při vytváření prázdného datového disku. Kopírovat: Tato hodnota se používá k vytvoření datového disku ze snímku nebo jiného disku. Obnovení: Tato hodnota se používá k vytvoření datového disku z bodu obnovení disku.
deleteOption	DiskDeleteOptionTypes	Určuje, jestli se má datový disk při odstranění virtuálního počítače odstranit nebo odpojit. Možné hodnoty jsou: Delete. Pokud se použije tato hodnota, datový disk se při odstranění virtuálního počítače odstraní. Odpojit. Pokud se použije tato hodnota, datový disk se po odstranění virtuálního počítače zachová. Výchozí hodnota je nastavená na Odpojit.
detachOption	DiskDetachOptionTypes	Určuje chování při odpojování, které se má použít při odpojování disku nebo které již probíhá odpojování od virtuálního počítače. Podporované hodnoty: ForceDetach. detachOption: 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 vynucené odpojení jako poslední možnost k vynucení odpojení disku od virtuálního počítače. Při použití tohoto chování při odpojení nemusely být vyprázdněné všechny zápisy. Tato funkce je stále v režimu Preview a virtualMachineScaleSet ji nepodporuje. Pokud chcete vynutit odpojení datového disku, aktualizujte na hodnotuBeDetached na true spolu s nastavením detachOption: ForceDetach.
diskIOPSReadWrite	integer	Určuje Read-Write IOPS spravovaného disku při UltraSSD_LRS StorageAccountType. Vráceno pouze pro disky VirtualMachine ScaleSet virtuálních počítačů. Lze aktualizovat pouze prostřednictvím aktualizací škálovací sady VirtualMachine.
diskMBpsReadWrite	integer	Určuje šířku pásma spravovaného disku v MB za sekundu při UltraSSD_LRS StorageAccountType. Vráceno pouze pro disky VirtualMachine ScaleSet virtuálních počítačů. Lze 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ů × 1024^3 disku a hodnota nesmí být větší než 1023.
image	VirtualHardDisk	Virtuální pevný disk image zdrojového uživatele. Virtuální pevný disk se před připojením k virtuálnímu počítači zkopíruje. Pokud je k dispozici SourceImage, cílový virtuální pevný disk nesmí existovat.
lun	integer	Určuje číslo logické jednotky datového disku. Tato hodnota slouží 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 se jednat o snímek nebo bod obnovení disku, ze kterého chcete vytvořit disk.
toBeDetached	boolean	Určuje, jestli probíhá odpojení datového disku od sady 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. ReadOnly pro Premium Storage.
deleteOption	DiskDeleteOptionTypes	Určuje, jestli se má datový disk při odstranění virtuálního počítače odstranit nebo odpojit. Možné hodnoty jsou: Delete. Pokud se použije tato hodnota, datový disk se při odstranění virtuálního počítače odstraní. Odpojit. Pokud se použije tato hodnota, datový disk se zachová i po odstranění virtuálního počítače. Výchozí hodnota je nastavená na Odpojit.
diskEncryptionSet	DiskEncryptionSetParameters	Určuje ID prostředku sady šifrování disků spravovaných zákazníkem pro spravovaný disk.
diskId	string	ID spravovaného datového disku.
lun	integer	Číslo logické jednotky 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 není zadána, logickou jednotku přiřadíte automaticky.
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	K dispozici jsou podporované možnosti pro odpojení disku od 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 nastavení dočasného disku pro disk operačního systému.

Name	Typ	Description
Local	string

DiffDiskPlacement

Určuje umístění dočasného disku pro disk s operačním systémem. 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 se použije ResourceDisk nebo NvmeDisk. Pokud chcete zjistit, které velikosti virtuálních počítačů zpřístupňují disk mezipaměti, 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 https://docs.microsoft.com/azure/virtual-machines/linux/sizes s Linuxem. Minimální verze rozhraní 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 nastavení dočasného disku pro disk operačního systému.
placement	DiffDiskPlacement	Určuje umístění dočasného disku pro disk s operačním systémem. 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 se použije ResourceDisk nebo NvmeDisk. Informace o velikostech virtuálních počítačů, které disk mezipaměti zpřístupňují, najdete v dokumentaci k velikostem virtuálních počítačů pro virtuální počítač s Windows na https://docs.microsoft.com/azure/virtual-machines/windows/sizes a virtuálním počítači s Linuxem na https://docs.microsoft.com/azure/virtual-machines/linux/sizes adrese. Minimální verze api-pro NvmeDisk: 2024-03-01.

DiskControllerTypes

Určuje typ řadiče disku nakonfigurovaný pro virtuální počítač. Poznámka: Tato vlastnost se nastaví na výchozí typ řadiče disku, pokud není zadána za předpokladu, že se virtuální počítač vytváří s hyperVGeneration nastavenou na hodnotu V2 na základě možností disku s operačním systémem a velikosti virtuálního počítače ze zadané minimální verze rozhraní API. Před aktualizací jeho typu řadiče disku je potřeba virtuální počítač uvolnit, pokud neaktualizujete velikost virtuálního počítače v konfiguraci virtuálního počítače, která implicitně zruší a přerozdělí virtuální počítač. Minimální verze api-version: 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 Připojit: Tato hodnota se používá, když k vytvoření virtuálního počítače používáte specializovaný disk. FromImage: Tato hodnota se používá, když k vytvoření virtuálního počítače používáte image. Pokud používáte image platformy, měli byste také použít element imageReference popsaný výše. Pokud používáte image z marketplace, měli byste také použít dříve popsaný element plánu.

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

DiskDeleteOptionTypes

Určuje, jestli se má při odstranění virtuálního počítače odstranit nebo odpojit disk s operačním systémem. Možné hodnoty jsou: Delete. Pokud se použije tato hodnota, disk s operačním systémem se při odstranění virtuálního počítače odstraní. Odpojit. Pokud se použije tato hodnota, disk s operačním systémem se zachová i po odstranění virtuálního počítače. Výchozí hodnota je nastavená 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í při odpojování, které se má použít při odpojování disku nebo které již probíhá v procesu odpojování od virtuálního počítače. Podporované hodnoty: ForceDetach. detachOption: ForceDetach se dá použít jenom pro spravované datové disky. Pokud se předchozí pokus o odpojení datového disku nedokončil kvůli neočekávanému selhání virtuálního počítače a disk stále není uvolněný, použijte vynucené odpojení jako poslední možnost k vynucení odpojení disku od virtuálního počítače. Při použití tohoto chování při odpojení nemusí být vyprázdněny všechny zápisy. Tato funkce je stále v režimu preview a virtualMachineScaleSet se nepodporuje. Pokud chcete vynutit odpojení datového disku, aktualizujte na hodnotuBeDetached na true spolu s nastavením detachOption: ForceDetach.

Name	Typ	Description
ForceDetach	string

DiskEncryptionSetParameters

Určuje ID prostředku sady šifrování disků spravovaných 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-version: 2015-06-15.

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

ImageReference

Určuje informace o obrázku, který se má použít. Můžete zadat informace o imagích platforem, 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. Můžete ho načíst z obrázku GET v galerii komunity.
exactVersion	string	Určuje v desítkových číslech verzi image platformy nebo image marketplace, která se používá k vytvoření virtuálního počítače. Toto pole jen pro čtení se liší od "version" pouze v případě, že hodnota zadaná v poli version je "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 sdíleného obrázku galerie – volání GET.
sku	string	Skladová položka image.
version	string	Určuje verzi image platformy nebo image marketplace použité k vytvoření virtuálního počítače. Povolené formáty jsou Major.Minor.Build nebo "latest". Hlavní číslo, Podverze a Sestavení jsou desetinná čísla. Pokud chcete použít nejnovější verzi image dostupnou v době nasazení, zadejte "nejnovější". I když použijete nejnovější verzi, image virtuálního počítače se po nasazení automaticky neaktualizuje, a to ani v případě, že bude k dispozici nová verze. Nepoužívejte pole version pro nasazení image galerie, image galerie by měla vždy používat pole id pro nasazení. Pokud chcete použít nejnovější verzi image galerie, stačí nastavit /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName} v poli id bez zadání verze.

InnerError

Podrobnosti o vnitřní chybě.

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 v Key Vault.

Name	Typ	Description
keyUrl	string	Adresa URL odkazující na šifrovací klíč klíče v Key Vault.
sourceVault	SubResource	Relativní adresa URL Key Vault obsahující klíč.

KeyVaultSecretReference

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

Name	Typ	Description
secretUrl	string	Adresa URL odkazující na tajný kód v Key Vault.
sourceVault	SubResource	Relativní adresa URL Key Vault obsahující tajný kód.

ManagedDiskParameters

Parametry spravovaného disku.

Name	Typ	Description
diskEncryptionSet	DiskEncryptionSetParameters	Určuje ID prostředku sady prostředků šifrování 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 je 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. ReadOnly pro Premium Storage.
createOption	DiskCreateOptionTypes	Určuje, jak se má vytvořit disk virtuálního počítače. Možné hodnoty jsou Připojit: Tato hodnota se používá, když k vytvoření virtuálního počítače používáte specializovaný disk. FromImage: Tato hodnota se používá, když k vytvoření virtuálního počítače používáte image. 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 použít také dříve popsaný prvek plánu.
deleteOption	DiskDeleteOptionTypes	Určuje, jestli se má při odstranění virtuálního počítače odstranit nebo odpojit disk s operačním systémem. Možné hodnoty jsou: Delete. Pokud se použije tato hodnota, disk s operačním systémem se při odstranění virtuálního počítače odstraní. Odpojit. Pokud se použije tato hodnota, disk s operačním systémem se zachová i po odstranění virtuálního počítače. Výchozí hodnota je nastavená 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 nesmí být větší než 1023.
encryptionSettings	DiskEncryptionSettings	Určuje nastavení šifrování disku s operačním systémem. Minimální verze rozhraní API: 2015-06-15.
image	VirtualHardDisk	Virtuální pevný disk zdrojové image uživatele. Virtuální pevný disk se před připojením k virtuálnímu počítači zkopíruje. 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 nastavená na DiskWithVMGuestState pro šifrování spravovaného disku spolu s objektem blob VMGuestState, VMGuestStateOnly pro šifrování pouze objektu blob VMGuestState a NonPersistedTPM pro neuchovávání stavu firmwaru v objektu blob VMGuestState. Poznámka: Dá se nastavit jenom 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 ji 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 se nastaví na výchozí typ řadiče disku, pokud není zadáno, že se virtuální počítač vytváří s hyperVGeneration nastavenou na V2 na základě možností disku operačního systému a velikosti virtuálního počítače ze zadané minimální verze rozhraní API. Před aktualizací jeho 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á implicitně zruší přidělení a přerozdělí virtuální počítač. Minimální verze rozhraní API: 2022-08-01.
imageReference	ImageReference	Určuje informace o obrázku, který se má použít. Můžete zadat informace o imagích platforem, 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ů sady šifrování spravovaných disků zákazníka pro spravovaný disk, který se používá pro disky s operačním systémem spravovaného zákazníkem šifrované pomocí důvěrného virtuálního počítače a objekt blob virtuálních počítačů.
securityEncryptionType	securityEncryptionTypes	Určuje Typ šifrování spravovaného disku. Je nastavená na DiskWithVMGuestState pro šifrování spravovaného disku spolu s objektem blob VMGuestState, VMGuestStateOnly pro šifrování pouze objektu blob VMGuestState a NonPersistedTPM pro neuchovávání stavu firmwaru v objektu blob VMGuestState. Poznámka: Dá se nastavit jenom pro důvěrné virtuální počítače.