Virtual Machine Scale Set VMs - Attach Detach Data Disks

Service:

Compute

API Version:

2024-03-01

Dołączanie i odłączanie dysków danych do/z maszyny wirtualnej w zestawie skalowania maszyn wirtualnych.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
instanceId	path	True	string	Identyfikator wystąpienia maszyny wirtualnej.
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
vmScaleSetName	path	True	string	Nazwa zestawu skalowania maszyn wirtualnych.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
parameters	AttachDetachDataDisksRequest	Parametry dostarczone do operacji dołączania i odłączania dysków danych na maszynie wirtualnej Virtual Machine Scale Sets.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	StorageProfile	OK
202 Accepted		Zaakceptowano Headers Location: string
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa	Opis
ApiEntityReference	Identyfikator zasobu źródłowego. Może to być migawka lub punkt przywracania dysku, z którego ma zostać utworzony dysk.
ApiError	Błąd interfejsu API.
ApiErrorBase	Baza błędów interfejsu API.
AttachDetachDataDisksRequest	Parametry dostarczone do operacji dołączania i odłączania dysków danych na maszynie wirtualnej Virtual Machine Scale Sets.
CachingTypes	Określa wymagania dotyczące buforowania. Możliwe wartości to: None,ReadOnly,ReadWrite. Domyślne zachowanie to: Brak dla magazynu w warstwie Standardowa. ReadOnly dla usługi Premium Storage.
CloudError	Odpowiedź o błędzie z usługi Compute.
DataDisk	Określa parametry używane do dodawania dysku danych do maszyny wirtualnej. Aby uzyskać więcej informacji na temat dysków, zobacz About disks and VHDs for Azure virtual machines (Informacje o dyskach i dyskach VHD dla maszyn wirtualnych platformy Azure).
DataDisksToAttach	Lista dysków danych zarządzanych do dołączenia.
DataDisksToDetach	Lista dysków danych zarządzanych do odłączenia.
DiffDiskOptions	Określa ustawienia efemerycznego dysku dla dysku systemu operacyjnego.
DiffDiskPlacement	Określa efemeryczne umieszczanie dysku dla dysku systemu operacyjnego. Możliwe wartości to: CacheDisk,ResourceDisk,NvmeDisk. Zachowaniem domyślnym jest: CacheDisk, jeśli jest skonfigurowany dla rozmiaru maszyny wirtualnej, w przeciwnym razie jest używany zasób ResourceDisk lub NvmeDisk. Zapoznaj się z dokumentacją rozmiaru maszyny wirtualnej z systemem Windows na maszynie https://docs.microsoft.com/azure/virtual-machines/windows/sizes wirtualnej z systemem Windows i maszyną wirtualną z systemem Linux, aby https://docs.microsoft.com/azure/virtual-machines/linux/sizes sprawdzić, które rozmiary maszyn wirtualnych uwidacznia dysk pamięci podręcznej. Minimalna wersja interfejsu API dla dysku NvmeDisk: 2024-03-01.
DiffDiskSettings	Określa efemeryczne ustawienia dysku dla dysku systemu operacyjnego używanego przez maszynę wirtualną.
DiskControllerTypes	Określa typ kontrolera dysku skonfigurowany dla maszyny wirtualnej. Uwaga: Ta właściwość zostanie ustawiona na domyślny typ kontrolera dysku, jeśli nie zostanie określona podana maszyna wirtualna zostanie utworzona z ustawieniem "hyperVGeneration" na wartość V2 na podstawie możliwości dysku systemu operacyjnego i rozmiaru maszyny wirtualnej z określonej minimalnej wersji interfejsu API. Należy cofnąć przydział maszyny wirtualnej przed zaktualizowaniem typu kontrolera dysku, chyba że aktualizujesz rozmiar maszyny wirtualnej w konfiguracji maszyny wirtualnej, która niejawnie cofnie przydział i cofnie przydział maszyny wirtualnej. Minimalna wersja interfejsu API: 2022-08-01.
DiskCreateOptionTypes	Określa sposób tworzenia dysku maszyny wirtualnej. Możliwe wartości to Dołączanie: ta wartość jest używana, gdy używasz wyspecjalizowanego dysku do utworzenia maszyny wirtualnej. FromImage: Ta wartość jest używana podczas tworzenia maszyny wirtualnej przy użyciu obrazu. Jeśli używasz obrazu platformy, należy również użyć elementu imageReference opisanego powyżej. Jeśli używasz obrazu witryny Marketplace, należy również użyć wcześniej opisanego elementu planu.
DiskDeleteOptionTypes	Określa, czy dysk systemu operacyjnego powinien zostać usunięty, czy odłączony po usunięciu maszyny wirtualnej. Możliwe wartości to: Usuń. Jeśli ta wartość jest używana, dysk systemu operacyjnego zostanie usunięty po usunięciu maszyny wirtualnej. Odłączyć. Jeśli ta wartość jest używana, dysk systemu operacyjnego jest zachowywany po usunięciu maszyny wirtualnej. Wartość domyślna jest ustawiona na Wartość Odłącz. W przypadku efemerycznego dysku systemu operacyjnego wartość domyślna jest ustawiona na Wartość Usuń. Użytkownik nie może zmienić opcji usuwania efemerycznego dysku systemu operacyjnego.
DiskDetachOptionTypes	Określa zachowanie odłączania, które ma być używane podczas odłączania dysku lub który jest już w trakcie odłączania od maszyny wirtualnej. Obsługiwane wartości: ForceDetach. detachOption: ForceDetach ma zastosowanie tylko dla zarządzanych dysków danych. Jeśli poprzednia próba odłączenia dysku danych nie została ukończona z powodu nieoczekiwanego błędu z maszyny wirtualnej, a dysk nadal nie został zwolniony, użyj opcji wymuszania odłączania jako ostatniej opcji odłączania dysku w celu wymuszonego odłączenia dysku od maszyny wirtualnej. Wszystkie zapisy mogły nie zostać opróżnione podczas korzystania z tego zachowania odłączania. Ta funkcja jest nadal w trybie wersji zapoznawczej i nie jest obsługiwana w przypadku zestawu VirtualMachineScaleSet. Aby wymusić odłączenie aktualizacji dysku danych na wartość "true" wraz z ustawieniem detachOption: "ForceDetach".
DiskEncryptionSetParameters	Określa identyfikator zasobu zestawu zasobów zestawu szyfrowania dysków zarządzanych przez klienta dla dysku zarządzanego.
DiskEncryptionSettings	Określa ustawienia szyfrowania dysku systemu operacyjnego. Minimalna wersja interfejsu API: 2015-06-15.
ImageReference	Określa informacje o obrazie do użycia. Możesz określić informacje o obrazach platformy, obrazach platformy handlowej lub obrazach maszyn wirtualnych. Ten element jest wymagany, gdy chcesz użyć obrazu platformy, obrazu witryny Marketplace lub obrazu maszyny wirtualnej, ale nie jest używany w innych operacjach tworzenia.
InnerError	Szczegóły błędu wewnętrznego.
KeyVaultKeyReference	Określa lokalizację klucza szyfrowania klucza w Key Vault.
KeyVaultSecretReference	Określa lokalizację klucza szyfrowania dysku, który jest kluczem tajnym Key Vault.
ManagedDiskParameters	Parametry dysku zarządzanego.
OperatingSystemTypes	Typ systemu operacyjnego.
OSDisk	Określa informacje o dysku systemu operacyjnego używanego przez maszynę wirtualną. Aby uzyskać więcej informacji na temat dysków, zobacz About disks and VHDs for Azure virtual machines (Informacje o dyskach i dyskach VHD dla maszyn wirtualnych platformy Azure).
securityEncryptionTypes	Określa typ szyfrowania dysku zarządzanego. Jest ona ustawiona na DiskWithVMGuestState na potrzeby szyfrowania dysku zarządzanego wraz z vmGuestState blob, VMGuestStateOnly na potrzeby szyfrowania tylko obiektu blob VMGuestState i nonPersistedTPM dla nietrwałego stanu oprogramowania układowego w obiekcie blob VMGuestState. Uwaga: Można go ustawić tylko dla poufnych maszyn wirtualnych.
StorageAccountTypes	Określa typ konta magazynu dla dysku zarządzanego. UWAGA: UltraSSD_LRS można używać tylko z dyskami danych. Nie można jej używać z dyskiem systemu operacyjnego.
StorageProfile	Określa ustawienia magazynu dla dysków maszyny wirtualnej.
SubResource
VirtualHardDisk	Wirtualny dysk twardy.
VMDiskSecurityProfile	Określa profil zabezpieczeń dysku zarządzanego.

ApiEntityReference

Identyfikator zasobu źródłowego. Może to być migawka lub punkt przywracania dysku, z którego ma zostać utworzony dysk.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu usługi ARM w postaci /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Błąd interfejsu API.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	ApiErrorBase[]	Szczegóły błędu interfejsu API
innererror	InnerError	Wewnętrzny błąd interfejsu API
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

ApiErrorBase

Baza błędów interfejsu API.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

AttachDetachDataDisksRequest

Parametry dostarczone do operacji dołączania i odłączania dysków danych na maszynie wirtualnej Virtual Machine Scale Sets.

Nazwa	Typ	Opis
dataDisksToAttach	DataDisksToAttach[]	Lista dysków danych zarządzanych do dołączenia.
dataDisksToDetach	DataDisksToDetach[]	Lista dysków danych zarządzanych do odłączenia.

CachingTypes

Określa wymagania dotyczące buforowania. Możliwe wartości to: None,ReadOnly,ReadWrite. Domyślne zachowanie to: Brak dla magazynu w warstwie Standardowa. ReadOnly dla usługi Premium Storage.

Nazwa	Typ	Opis
None	string
ReadOnly	string
ReadWrite	string

CloudError

Odpowiedź o błędzie z usługi Compute.

Nazwa	Typ	Opis
error	ApiError	Błąd interfejsu API.

DataDisk

Określa parametry używane do dodawania dysku danych do maszyny wirtualnej. Aby uzyskać więcej informacji na temat dysków, zobacz About disks and VHDs for Azure virtual machines (Informacje o dyskach i dyskach VHD dla maszyn wirtualnych platformy Azure).

Nazwa	Typ	Opis
caching	CachingTypes	Określa wymagania dotyczące buforowania. Możliwe wartości to: None,ReadOnly,ReadWrite. Domyślne zachowanie to: Brak dla magazynu w warstwie Standardowa. ReadOnly dla usługi Premium Storage.
createOption	DiskCreateOptionTypes	Określa sposób tworzenia dysku maszyny wirtualnej. Możliwe wartości to Dołączanie: ta wartość jest używana, gdy używasz wyspecjalizowanego dysku do utworzenia maszyny wirtualnej. FromImage: Ta wartość jest używana podczas używania obrazu do utworzenia dysku danych maszyny wirtualnej. Jeśli używasz obrazu platformy, należy również użyć elementu imageReference opisanego powyżej. Jeśli używasz obrazu witryny Marketplace, należy również użyć wcześniej opisanego elementu planu. Pusty: Ta wartość jest używana podczas tworzenia pustego dysku danych. Kopii: Ta wartość służy do tworzenia dysku danych na podstawie migawki lub innego dysku. Przywrócić: Ta wartość służy do tworzenia dysku danych z punktu przywracania dysku.
deleteOption	DiskDeleteOptionTypes	Określa, czy dysk danych powinien zostać usunięty, czy odłączony po usunięciu maszyny wirtualnej. Możliwe wartości to: Usuń. Jeśli ta wartość jest używana, dysk danych zostanie usunięty po usunięciu maszyny wirtualnej. Odłączyć. Jeśli ta wartość jest używana, dysk danych jest zachowywany po usunięciu maszyny wirtualnej. Wartość domyślna jest ustawiona na Wartość Odłącz.
detachOption	DiskDetachOptionTypes	Określa zachowanie odłączania, które ma być używane podczas odłączania dysku lub który jest już w trakcie odłączania od maszyny wirtualnej. Obsługiwane wartości: ForceDetach. detachOption: ForceDetach ma zastosowanie tylko dla zarządzanych dysków danych. Jeśli poprzednia próba odłączenia dysku danych nie została ukończona z powodu nieoczekiwanego błędu z maszyny wirtualnej, a dysk nadal nie został zwolniony, użyj opcji wymuszania odłączania jako ostatniej opcji odłączania dysku w celu wymuszonego odłączenia dysku od maszyny wirtualnej. Wszystkie zapisy mogły nie zostać opróżnione podczas korzystania z tego zachowania odłączania. Ta funkcja jest nadal w trybie wersji zapoznawczej i nie jest obsługiwana w przypadku zestawu VirtualMachineScaleSet. Aby wymusić odłączenie aktualizacji dysku danych na wartość "true" wraz z ustawieniem detachOption: "ForceDetach".
diskIOPSReadWrite	integer	Określa Read-Write liczby operacji we/wy na sekundę dla dysku zarządzanego, gdy parametr StorageAccountType jest UltraSSD_LRS. Zwrócone tylko dla dysków maszyn wirtualnych VirtualMachine ScaleSet. Można aktualizować tylko za pośrednictwem aktualizacji zestawu skalowania VirtualMachine.
diskMBpsReadWrite	integer	Określa przepustowość w MB na sekundę dla dysku zarządzanego, gdy parametr StorageAccountType jest UltraSSD_LRS. Zwrócone tylko dla dysków maszyn wirtualnych VirtualMachine ScaleSet. Można aktualizować tylko za pośrednictwem aktualizacji zestawu skalowania VirtualMachine.
diskSizeGB	integer	Określa rozmiar pustego dysku danych w gigabajtach. Ten element może służyć do zastępowania rozmiaru dysku na obrazie maszyny wirtualnej. Właściwość "diskSizeGB" to liczba bajtów x 1024^3 dla dysku, a wartość nie może być większa niż 1023.
image	VirtualHardDisk	Źródłowy obraz użytkownika wirtualny dysk twardy. Wirtualny dysk twardy zostanie skopiowany przed dołączeniem do maszyny wirtualnej. Jeśli jest dostarczany obiekt SourceImage, docelowy wirtualny dysk twardy nie może istnieć.
lun	integer	Określa numer jednostki logicznej dysku danych. Ta wartość służy do identyfikowania dysków danych na maszynie wirtualnej i dlatego musi być unikatowa dla każdego dysku danych dołączonego do maszyny wirtualnej.
managedDisk	ManagedDiskParameters	Parametry dysku zarządzanego.
name	string	Nazwa dysku.
sourceResource	ApiEntityReference	Identyfikator zasobu źródłowego. Może to być migawka lub punkt przywracania dysku, z którego ma zostać utworzony dysk.
toBeDetached	boolean	Określa, czy dysk danych jest w trakcie odłączania od zestawu VirtualMachine/VirtualMachineScaleset
vhd	VirtualHardDisk	Wirtualny dysk twardy.
writeAcceleratorEnabled	boolean	Określa, czy na dysku należy włączyć lub wyłączyć funkcję writeAccelerator.

DataDisksToAttach

Lista dysków danych zarządzanych do dołączenia.

Nazwa	Typ	Opis
caching	CachingTypes	Określa wymagania dotyczące buforowania. Możliwe wartości to: None,ReadOnly,ReadWrite. Domyślne zachowanie to: Brak dla magazynu w warstwie Standardowa. ReadOnly dla usługi Premium Storage.
deleteOption	DiskDeleteOptionTypes	Określa, czy dysk danych powinien zostać usunięty, czy odłączony po usunięciu maszyny wirtualnej. Możliwe wartości to: Usuń. Jeśli ta wartość jest używana, dysk danych zostanie usunięty po usunięciu maszyny wirtualnej. Odłączyć. Jeśli ta wartość jest używana, dysk danych jest zachowywany po usunięciu maszyny wirtualnej. Wartość domyślna jest ustawiona na Wartość Odłącz.
diskEncryptionSet	DiskEncryptionSetParameters	Określa identyfikator zasobu zestawu zasobów zestawu szyfrowania dysków zarządzanych przez klienta dla dysku zarządzanego.
diskId	string	Identyfikator dysku danych zarządzanych.
lun	integer	Numer jednostki logicznej dysku danych. Ta wartość służy do identyfikowania dysków danych na maszynie wirtualnej i dlatego musi być unikatowa dla każdego dysku danych dołączonego do maszyny wirtualnej. Jeśli nie zostanie określony, jednostka lun zostanie przypisana automatycznie.
writeAcceleratorEnabled	boolean	Określa, czy na dysku należy włączyć lub wyłączyć funkcję writeAccelerator.

DataDisksToDetach

Lista dysków danych zarządzanych do odłączenia.

Nazwa	Typ	Opis
detachOption	DiskDetachOptionTypes	Obsługiwane opcje dostępne dla odłączenia dysku od maszyny wirtualnej. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją obiektu DetachOption.
diskId	string	Identyfikator dysku danych zarządzanych.

DiffDiskOptions

Określa ustawienia efemerycznego dysku dla dysku systemu operacyjnego.

Nazwa	Typ	Opis
Local	string

DiffDiskPlacement

Określa efemeryczne umieszczanie dysku dla dysku systemu operacyjnego. Możliwe wartości to: CacheDisk,ResourceDisk,NvmeDisk. Zachowaniem domyślnym jest: CacheDisk, jeśli jest skonfigurowany dla rozmiaru maszyny wirtualnej, w przeciwnym razie jest używany zasób ResourceDisk lub NvmeDisk. Zapoznaj się z dokumentacją rozmiaru maszyny wirtualnej z systemem Windows na maszynie https://docs.microsoft.com/azure/virtual-machines/windows/sizes wirtualnej z systemem Windows i maszyną wirtualną z systemem Linux, aby https://docs.microsoft.com/azure/virtual-machines/linux/sizes sprawdzić, które rozmiary maszyn wirtualnych uwidacznia dysk pamięci podręcznej. Minimalna wersja interfejsu API dla dysku NvmeDisk: 2024-03-01.

Nazwa	Typ	Opis
CacheDisk	string
NvmeDisk	string
ResourceDisk	string

DiffDiskSettings

Określa efemeryczne ustawienia dysku dla dysku systemu operacyjnego używanego przez maszynę wirtualną.

Nazwa	Typ	Opis
option	DiffDiskOptions	Określa ustawienia efemerycznego dysku dla dysku systemu operacyjnego.
placement	DiffDiskPlacement	Określa efemeryczne umieszczanie dysku dla dysku systemu operacyjnego. Możliwe wartości to: CacheDisk,ResourceDisk,NvmeDisk. Zachowaniem domyślnym jest: CacheDisk, jeśli jest skonfigurowany dla rozmiaru maszyny wirtualnej, w przeciwnym razie jest używany zasób ResourceDisk lub NvmeDisk. Zapoznaj się z dokumentacją rozmiaru maszyny wirtualnej z systemem Windows na maszynie https://docs.microsoft.com/azure/virtual-machines/windows/sizes wirtualnej z systemem Windows i maszyną wirtualną z systemem Linux, aby https://docs.microsoft.com/azure/virtual-machines/linux/sizes sprawdzić, które rozmiary maszyn wirtualnych uwidacznia dysk pamięci podręcznej. Minimalna wersja interfejsu API dla dysku NvmeDisk: 2024-03-01.

DiskControllerTypes

Określa typ kontrolera dysku skonfigurowany dla maszyny wirtualnej. Uwaga: Ta właściwość zostanie ustawiona na domyślny typ kontrolera dysku, jeśli nie zostanie określona podana maszyna wirtualna zostanie utworzona z ustawieniem "hyperVGeneration" na wartość V2 na podstawie możliwości dysku systemu operacyjnego i rozmiaru maszyny wirtualnej z określonej minimalnej wersji interfejsu API. Należy cofnąć przydział maszyny wirtualnej przed zaktualizowaniem typu kontrolera dysku, chyba że aktualizujesz rozmiar maszyny wirtualnej w konfiguracji maszyny wirtualnej, która niejawnie cofnie przydział i cofnie przydział maszyny wirtualnej. Minimalna wersja interfejsu API: 2022-08-01.

Nazwa	Typ	Opis
NVMe	string
SCSI	string

DiskCreateOptionTypes

Określa sposób tworzenia dysku maszyny wirtualnej. Możliwe wartości to Dołączanie: ta wartość jest używana, gdy używasz wyspecjalizowanego dysku do utworzenia maszyny wirtualnej. FromImage: Ta wartość jest używana podczas tworzenia maszyny wirtualnej przy użyciu obrazu. Jeśli używasz obrazu platformy, należy również użyć elementu imageReference opisanego powyżej. Jeśli używasz obrazu witryny Marketplace, należy również użyć wcześniej opisanego elementu planu.

Nazwa	Typ	Opis
Attach	string
Copy	string
Empty	string
FromImage	string
Restore	string

DiskDeleteOptionTypes

Określa, czy dysk systemu operacyjnego powinien zostać usunięty, czy odłączony po usunięciu maszyny wirtualnej. Możliwe wartości to: Usuń. Jeśli ta wartość jest używana, dysk systemu operacyjnego zostanie usunięty po usunięciu maszyny wirtualnej. Odłączyć. Jeśli ta wartość jest używana, dysk systemu operacyjnego jest zachowywany po usunięciu maszyny wirtualnej. Wartość domyślna jest ustawiona na Wartość Odłącz. W przypadku efemerycznego dysku systemu operacyjnego wartość domyślna jest ustawiona na Wartość Usuń. Użytkownik nie może zmienić opcji usuwania efemerycznego dysku systemu operacyjnego.

Nazwa	Typ	Opis
Delete	string
Detach	string

DiskDetachOptionTypes

Określa zachowanie odłączania, które ma być używane podczas odłączania dysku lub który jest już w trakcie odłączania od maszyny wirtualnej. Obsługiwane wartości: ForceDetach. detachOption: ForceDetach ma zastosowanie tylko dla zarządzanych dysków danych. Jeśli poprzednia próba odłączenia dysku danych nie została ukończona z powodu nieoczekiwanego błędu z maszyny wirtualnej, a dysk nadal nie został zwolniony, użyj opcji wymuszania odłączania jako ostatniej opcji odłączania dysku w celu wymuszonego odłączenia dysku od maszyny wirtualnej. Wszystkie zapisy mogły nie zostać opróżnione podczas korzystania z tego zachowania odłączania. Ta funkcja jest nadal w trybie wersji zapoznawczej i nie jest obsługiwana w przypadku zestawu VirtualMachineScaleSet. Aby wymusić odłączenie aktualizacji dysku danych na wartość "true" wraz z ustawieniem detachOption: "ForceDetach".

Nazwa	Typ	Opis
ForceDetach	string

DiskEncryptionSetParameters

Określa identyfikator zasobu zestawu zasobów zestawu szyfrowania dysków zarządzanych przez klienta dla dysku zarządzanego.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu

DiskEncryptionSettings

Określa ustawienia szyfrowania dysku systemu operacyjnego. Minimalna wersja interfejsu API: 2015-06-15.

Nazwa	Typ	Opis
diskEncryptionKey	KeyVaultSecretReference	Określa lokalizację klucza szyfrowania dysku, który jest kluczem tajnym Key Vault.
enabled	boolean	Określa, czy szyfrowanie dysków powinno być włączone na maszynie wirtualnej.
keyEncryptionKey	KeyVaultKeyReference	Określa lokalizację klucza szyfrowania klucza w Key Vault.

ImageReference

Określa informacje o obrazie do użycia. Możesz określić informacje o obrazach platformy, obrazach platformy handlowej lub obrazach maszyn wirtualnych. Ten element jest wymagany, gdy chcesz użyć obrazu platformy, obrazu witryny Marketplace lub obrazu maszyny wirtualnej, ale nie jest używany w innych operacjach tworzenia.

Nazwa	Typ	Opis
communityGalleryImageId	string	Określono unikatowy identyfikator obrazu galerii społeczności dla wdrożenia maszyny wirtualnej. Można to pobrać z poziomu wywołania GET obrazu galerii społeczności.
exactVersion	string	Określa liczbę dziesiętną, wersję obrazu platformy lub obrazu platformy handlowej używanego do tworzenia maszyny wirtualnej. To pole readonly różni się od "wersji", tylko wtedy, gdy wartość określona w polu "version" to "latest".
id	string	Identyfikator zasobu
offer	string	Określa ofertę obrazu platformy lub obrazu platformy handlowej używanego do tworzenia maszyny wirtualnej.
publisher	string	Wydawca obrazów.
sharedGalleryImageId	string	Określono unikatowy identyfikator obrazu galerii udostępnionej dla wdrożenia maszyny wirtualnej. Można to pobrać z udostępnionego obrazu galerii wywołanie GET.
sku	string	Jednostka SKU obrazu.
version	string	Określa wersję obrazu platformy lub obrazu platformy handlowej używanego do utworzenia maszyny wirtualnej. Dozwolone formaty to Major.Minor.Build lub "latest". Liczba główna, pomocnicza i kompilacja to liczby dziesiętne. Określ wartość "latest", aby użyć najnowszej wersji obrazu dostępnego w czasie wdrażania. Nawet jeśli używasz polecenia "latest", obraz maszyny wirtualnej nie zostanie automatycznie zaktualizowany po wdrożeniu, nawet jeśli nowa wersja stanie się dostępna. Nie używaj pola "version" do wdrożenia obrazu galerii, obraz galerii powinien zawsze używać pola "id" do wdrożenia, aby użyć "najnowszej" wersji obrazu galerii, po prostu ustaw wartość "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageName}" w polu "id" bez danych wejściowych wersji.

InnerError

Szczegóły błędu wewnętrznego.

Nazwa	Typ	Opis
errordetail	string	Wewnętrzny komunikat o błędzie lub zrzut wyjątku.
exceptiontype	string	Typ wyjątku.

KeyVaultKeyReference

Określa lokalizację klucza szyfrowania klucza w Key Vault.

Nazwa	Typ	Opis
keyUrl	string	Adres URL odwołującego się do klucza szyfrowania kluczy w Key Vault.
sourceVault	SubResource	Względny adres URL Key Vault zawierający klucz.

KeyVaultSecretReference

Określa lokalizację klucza szyfrowania dysku, który jest kluczem tajnym Key Vault.

Nazwa	Typ	Opis
secretUrl	string	Adres URL odwołujące się do wpisu tajnego w Key Vault.
sourceVault	SubResource	Względny adres URL Key Vault zawierający wpis tajny.

ManagedDiskParameters

Parametry dysku zarządzanego.

Nazwa	Typ	Opis
diskEncryptionSet	DiskEncryptionSetParameters	Określa identyfikator zasobu zestawu zasobów zestawu szyfrowania dysków zarządzanych przez klienta dla dysku zarządzanego.
id	string	Identyfikator zasobu
securityProfile	VMDiskSecurityProfile	Określa profil zabezpieczeń dysku zarządzanego.
storageAccountType	StorageAccountTypes	Określa typ konta magazynu dla dysku zarządzanego. UWAGA: UltraSSD_LRS można używać tylko z dyskami danych. Nie można jej używać z dyskiem systemu operacyjnego.

OperatingSystemTypes

Typ systemu operacyjnego.

Nazwa	Typ	Opis
Linux	string
Windows	string

OSDisk

Określa informacje o dysku systemu operacyjnego używanego przez maszynę wirtualną. Aby uzyskać więcej informacji na temat dysków, zobacz About disks and VHDs for Azure virtual machines (Informacje o dyskach i dyskach VHD dla maszyn wirtualnych platformy Azure).

Nazwa	Typ	Opis
caching	CachingTypes	Określa wymagania dotyczące buforowania. Możliwe wartości to: None,ReadOnly,ReadWrite. Domyślne zachowanie to: Brak dla magazynu w warstwie Standardowa. ReadOnly dla usługi Premium Storage.
createOption	DiskCreateOptionTypes	Określa sposób tworzenia dysku maszyny wirtualnej. Możliwe wartości to Dołączanie: ta wartość jest używana, gdy używasz wyspecjalizowanego dysku do utworzenia maszyny wirtualnej. FromImage: Ta wartość jest używana podczas tworzenia maszyny wirtualnej przy użyciu obrazu. Jeśli używasz obrazu platformy, należy również użyć elementu imageReference opisanego powyżej. Jeśli używasz obrazu witryny Marketplace, należy również użyć wcześniej opisanego elementu planu.
deleteOption	DiskDeleteOptionTypes	Określa, czy dysk systemu operacyjnego powinien zostać usunięty, czy odłączony po usunięciu maszyny wirtualnej. Możliwe wartości to: Usuń. Jeśli ta wartość jest używana, dysk systemu operacyjnego zostanie usunięty po usunięciu maszyny wirtualnej. Odłączyć. Jeśli ta wartość jest używana, dysk systemu operacyjnego jest zachowywany po usunięciu maszyny wirtualnej. Wartość domyślna jest ustawiona na Wartość Odłącz. W przypadku efemerycznego dysku systemu operacyjnego wartość domyślna jest ustawiona na Wartość Usuń. Użytkownik nie może zmienić opcji usuwania efemerycznego dysku systemu operacyjnego.
diffDiskSettings	DiffDiskSettings	Określa efemeryczne ustawienia dysku dla dysku systemu operacyjnego używanego przez maszynę wirtualną.
diskSizeGB	integer	Określa rozmiar pustego dysku danych w gigabajtach. Ten element może służyć do zastępowania rozmiaru dysku na obrazie maszyny wirtualnej. Właściwość "diskSizeGB" to liczba bajtów x 1024^3 dla dysku, a wartość nie może być większa niż 1023.
encryptionSettings	DiskEncryptionSettings	Określa ustawienia szyfrowania dysku systemu operacyjnego. Minimalna wersja interfejsu API: 2015-06-15.
image	VirtualHardDisk	Źródłowy obraz użytkownika wirtualny dysk twardy. Wirtualny dysk twardy zostanie skopiowany przed dołączeniem do maszyny wirtualnej. Jeśli jest dostarczany obiekt SourceImage, docelowy wirtualny dysk twardy nie może istnieć.
managedDisk	ManagedDiskParameters	Parametry dysku zarządzanego.
name	string	Nazwa dysku.
osType	OperatingSystemTypes	Ta właściwość umożliwia określenie typu systemu operacyjnego dołączonego do dysku w przypadku tworzenia maszyny wirtualnej na podstawie obrazu użytkownika lub wyspecjalizowanego wirtualnego dysku twardego. Możliwe wartości to: Windows,Linux.
vhd	VirtualHardDisk	Wirtualny dysk twardy.
writeAcceleratorEnabled	boolean	Określa, czy na dysku należy włączyć lub wyłączyć funkcję writeAccelerator.

securityEncryptionTypes

Określa typ szyfrowania dysku zarządzanego. Jest ona ustawiona na DiskWithVMGuestState na potrzeby szyfrowania dysku zarządzanego wraz z vmGuestState blob, VMGuestStateOnly na potrzeby szyfrowania tylko obiektu blob VMGuestState i nonPersistedTPM dla nietrwałego stanu oprogramowania układowego w obiekcie blob VMGuestState. Uwaga: Można go ustawić tylko dla poufnych maszyn wirtualnych.

Nazwa	Typ	Opis
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

StorageAccountTypes

Określa typ konta magazynu dla dysku zarządzanego. UWAGA: UltraSSD_LRS można używać tylko z dyskami danych. Nie można jej używać z dyskiem systemu operacyjnego.

Nazwa	Typ	Opis
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

StorageProfile

Określa ustawienia magazynu dla dysków maszyny wirtualnej.

Nazwa	Typ	Opis
dataDisks	DataDisk[]	Określa parametry używane do dodawania dysku danych do maszyny wirtualnej. Aby uzyskać więcej informacji na temat dysków, zobacz About disks and VHDs for Azure virtual machines (Informacje o dyskach i dyskach VHD dla maszyn wirtualnych platformy Azure).
diskControllerType	DiskControllerTypes	Określa typ kontrolera dysku skonfigurowany dla maszyny wirtualnej. Uwaga: Ta właściwość zostanie ustawiona na domyślny typ kontrolera dysku, jeśli nie zostanie określona podana maszyna wirtualna zostanie utworzona z ustawieniem "hyperVGeneration" na wartość V2 na podstawie możliwości dysku systemu operacyjnego i rozmiaru maszyny wirtualnej z określonej minimalnej wersji interfejsu API. Należy cofnąć przydział maszyny wirtualnej przed zaktualizowaniem typu kontrolera dysku, chyba że aktualizujesz rozmiar maszyny wirtualnej w konfiguracji maszyny wirtualnej, która niejawnie cofnie przydział i cofnie przydział maszyny wirtualnej. Minimalna wersja interfejsu API: 2022-08-01.
imageReference	ImageReference	Określa informacje o obrazie do użycia. Możesz określić informacje o obrazach platformy, obrazach platformy handlowej lub obrazach maszyn wirtualnych. Ten element jest wymagany, gdy chcesz użyć obrazu platformy, obrazu witryny Marketplace lub obrazu maszyny wirtualnej, ale nie jest używany w innych operacjach tworzenia.
osDisk	OSDisk	Określa informacje o dysku systemu operacyjnego używanego przez maszynę wirtualną. Aby uzyskać więcej informacji na temat dysków, zobacz About disks and VHDs for Azure virtual machines (Informacje o dyskach i dyskach VHD dla maszyn wirtualnych platformy Azure).

SubResource

Nazwa	Typ	Opis
id	string	Identyfikator zasobu

VirtualHardDisk

Wirtualny dysk twardy.

Nazwa	Typ	Opis
uri	string	Określa identyfikator URI wirtualnego dysku twardego.

VMDiskSecurityProfile

Określa profil zabezpieczeń dysku zarządzanego.

Nazwa	Typ	Opis
diskEncryptionSet	DiskEncryptionSetParameters	Określa identyfikator zasobu zestawu zasobów zestawu szyfrowania dysków zarządzanych klienta używany dla dysku zarządzanego przez klienta zaszyfrowanego poufnego dysku systemu operacyjnego maszyny wirtualnej i obiektu blob vmGuest.
securityEncryptionType	securityEncryptionTypes	Określa typ szyfrowania dysku zarządzanego. Jest ona ustawiona na DiskWithVMGuestState na potrzeby szyfrowania dysku zarządzanego wraz z vmGuestState blob, VMGuestStateOnly na potrzeby szyfrowania tylko obiektu blob VMGuestState i nonPersistedTPM dla nietrwałego stanu oprogramowania układowego w obiekcie blob VMGuestState. Uwaga: Można go ustawić tylko dla poufnych maszyn wirtualnych.