Virtual Machine Scale Set VMs - Attach Detach Data Disks

Layanan:

Compute

Versi API:

2024-03-01

Lampirkan dan lepaskan disk data ke/dari komputer virtual dalam set skala VM.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
instanceId	path	True	string	ID instans komputer virtual.
resourceGroupName	path	True	string	Nama grup sumber daya.
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
vmScaleSetName	path	True	string	Nama set skala VM.
api-version	query	True	string	Versi Api Klien.

Isi Permintaan

Nama	Jenis	Deskripsi
parameters	AttachDetachDataDisksRequest	Parameter yang disediakan untuk melampirkan dan melepaskan operasi disk data pada VM Virtual Machine Scale Sets.

Respons

Nama	Jenis	Deskripsi
200 OK	StorageProfile	OK
202 Accepted		Diterima Header Location: string
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen

VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen

VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen

Permintaan sampel

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

Respon sampel

Kode status:

200

location: https://foo.com/operationstatus

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

Kode status:

202

location: https://foo.com/operationstatus

VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen

Permintaan sampel

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

Respon sampel

Kode status:

200

location: https://foo.com/operationstatus

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

Kode status:

202

location: https://foo.com/operationstatus

Definisi

Nama	Deskripsi
ApiEntityReference	Pengidentifikasi sumber daya sumber. Ini bisa menjadi rekam jepret, atau titik pemulihan disk untuk membuat disk.
ApiError	Kesalahan api.
ApiErrorBase	Basis kesalahan api.
AttachDetachDataDisksRequest	Parameter yang disediakan untuk melampirkan dan melepaskan operasi disk data pada VM Virtual Machine Scale Sets.
CachingTypes	Menentukan persyaratan penembolokan. Nilai yang mungkin adalah: None,ReadOnly,ReadWrite. Perilaku defaultnya adalah: Tidak ada untuk penyimpanan Standar. ReadOnly untuk penyimpanan Premium.
CloudError	Respons kesalahan dari layanan Komputasi.
DataDisk	Menentukan parameter yang digunakan untuk menambahkan disk data ke komputer virtual. Untuk informasi selengkapnya tentang disk, lihat Tentang disk dan VHD untuk komputer virtual Azure.
DataDisksToAttach	Daftar disk data terkelola yang akan dilampirkan.
DataDisksToDetach	Daftar disk data terkelola yang akan dilepaskan.
DiffDiskOptions	Menentukan pengaturan disk ephemeral untuk disk sistem operasi.
DiffDiskPlacement	Menentukan penempatan disk ephemeral untuk disk sistem operasi. Nilai yang mungkin adalah: CacheDisk,ResourceDisk,NvmeDisk. Perilaku defaultnya adalah: CacheDisk jika dikonfigurasi untuk ukuran VM jika tidak, ResourceDisk atau NvmeDisk digunakan. Lihat dokumentasi ukuran VM untuk VM Windows di https://docs.microsoft.com/azure/virtual-machines/windows/sizes dan Linux VM di https://docs.microsoft.com/azure/virtual-machines/linux/sizes untuk memeriksa ukuran VM mana yang mengekspos disk cache. Versi api minimum untuk NvmeDisk: 2024-03-01.
DiffDiskSettings	Menentukan Pengaturan Disk ephemeral untuk disk sistem operasi yang digunakan oleh komputer virtual.
DiskControllerTypes	Menentukan jenis pengontrol disk yang dikonfigurasi untuk VM. Catatan: Properti ini akan diatur ke jenis pengontrol disk default jika tidak ditentukan asalkan komputer virtual sedang dibuat dengan 'hyperVGeneration' diatur ke V2 berdasarkan kemampuan disk sistem operasi dan ukuran VM dari versi api minimum yang ditentukan. Anda perlu membatalkan alokasi VM sebelum memperbarui jenis pengontrol disknya kecuali Anda memperbarui ukuran VM dalam konfigurasi VM yang secara implisit membatalkan alokasi dan merealokasi VM. Versi api minimum: 2022-08-01.
DiskCreateOptionTypes	Menentukan bagaimana disk komputer virtual harus dibuat. Nilai yang mungkin adalah Lampirkan: Nilai ini digunakan saat Anda menggunakan disk khusus untuk membuat komputer virtual. FromImage: Nilai ini digunakan saat Anda menggunakan gambar untuk membuat komputer virtual. Jika Anda menggunakan gambar platform, Anda juga harus menggunakan elemen imageReference yang dijelaskan di atas. Jika Anda menggunakan gambar marketplace, Anda juga harus menggunakan elemen paket yang dijelaskan sebelumnya.
DiskDeleteOptionTypes	Menentukan apakah Disk OS harus dihapus atau dilepas setelah penghapusan VM. Nilai yang mungkin adalah: Hapus. Jika nilai ini digunakan, disk OS dihapus saat VM dihapus. Melepaskan. Jika nilai ini digunakan, disk os dipertahankan setelah VM dihapus. Nilai default diatur ke Lepaskan. Untuk Disk OS sementara, nilai default diatur ke Hapus. Pengguna tidak dapat mengubah opsi hapus untuk Disk OS sementara.
DiskDetachOptionTypes	Menentukan perilaku pencopotan yang akan digunakan saat melepaskan disk atau yang sudah dalam proses pencopotan dari komputer virtual. Nilai yang didukung: ForceDetach. detachOption: ForceDetach hanya berlaku untuk disk data terkelola. Jika upaya pencopotan disk data sebelumnya tidak selesai karena kegagalan tak terduga dari komputer virtual dan disk masih belum dirilis, gunakan force-detach sebagai opsi upaya terakhir untuk melepaskan disk secara paksa dari VM. Semua tulisan mungkin belum dihapus saat menggunakan perilaku lepas ini. Fitur ini masih dalam mode pratinjau dan tidak didukung untuk VirtualMachineScaleSet. Untuk melepaskan paksa pembaruan disk data keBeDetached ke 'true' bersama dengan pengaturan detachOption: 'ForceDetach'.
DiskEncryptionSetParameters	Menentukan id sumber daya set enkripsi disk yang dikelola pelanggan untuk disk terkelola.
DiskEncryptionSettings	Menentukan pengaturan enkripsi untuk Disk OS. Versi api minimum: 2015-06-15.
ImageReference	Menentukan informasi tentang gambar yang akan digunakan. Anda dapat menentukan informasi tentang gambar platform, gambar marketplace, atau gambar komputer virtual. Elemen ini diperlukan ketika Anda ingin menggunakan gambar platform, gambar marketplace, atau gambar komputer virtual, tetapi tidak digunakan dalam operasi pembuatan lainnya.
InnerError	Detail kesalahan dalam.
KeyVaultKeyReference	Menentukan lokasi kunci enkripsi kunci di Key Vault.
KeyVaultSecretReference	Menentukan lokasi kunci enkripsi disk, yang merupakan Rahasia Key Vault.
ManagedDiskParameters	Parameter disk terkelola.
OperatingSystemTypes	Jenis Sistem Operasi.
OSDisk	Menentukan informasi tentang disk sistem operasi yang digunakan oleh komputer virtual. Untuk informasi selengkapnya tentang disk, lihat Tentang disk dan VHD untuk komputer virtual Azure.
securityEncryptionTypes	Menentukan EncryptionType dari disk terkelola. Ini diatur ke DiskWithVMGuestState untuk enkripsi disk terkelola bersama dengan blob VMGuestState, VMGuestStateOnly untuk enkripsi hanya blob VMGuestState, dan NonPersistedTPM untuk tidak mempertahankan status firmware di blob VMGuestState.. Catatan: Ini hanya dapat diatur untuk VM Rahasia.
StorageAccountTypes	Menentukan jenis akun penyimpanan untuk disk terkelola. CATATAN: UltraSSD_LRS hanya dapat digunakan dengan disk data, tidak dapat digunakan dengan Disk OS.
StorageProfile	Menentukan pengaturan penyimpanan untuk disk komputer virtual.
SubResource
VirtualHardDisk	Hard disk virtual.
VMDiskSecurityProfile	Menentukan profil keamanan untuk disk terkelola.

ApiEntityReference

Pengidentifikasi sumber daya sumber. Ini bisa menjadi rekam jepret, atau titik pemulihan disk untuk membuat disk.

Nama	Jenis	Deskripsi
id	string	Id sumber daya ARM dalam bentuk /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Kesalahan api.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
details	ApiErrorBase[]	Detail kesalahan Api
innererror	InnerError	Kesalahan dalam Api
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

ApiErrorBase

Basis kesalahan api.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

AttachDetachDataDisksRequest

Parameter yang disediakan untuk melampirkan dan melepaskan operasi disk data pada VM Virtual Machine Scale Sets.

Nama	Jenis	Deskripsi
dataDisksToAttach	DataDisksToAttach[]	Daftar disk data terkelola yang akan dilampirkan.
dataDisksToDetach	DataDisksToDetach[]	Daftar disk data terkelola yang akan dilepaskan.

CachingTypes

Menentukan persyaratan penembolokan. Nilai yang mungkin adalah: None,ReadOnly,ReadWrite. Perilaku defaultnya adalah: Tidak ada untuk penyimpanan Standar. ReadOnly untuk penyimpanan Premium.

Nama	Jenis	Deskripsi
None	string
ReadOnly	string
ReadWrite	string

CloudError

Respons kesalahan dari layanan Komputasi.

Nama	Jenis	Deskripsi
error	ApiError	Kesalahan api.

DataDisk

Menentukan parameter yang digunakan untuk menambahkan disk data ke komputer virtual. Untuk informasi selengkapnya tentang disk, lihat Tentang disk dan VHD untuk komputer virtual Azure.

Nama	Jenis	Deskripsi
caching	CachingTypes	Menentukan persyaratan penembolokan. Nilai yang mungkin adalah: None,ReadOnly,ReadWrite. Perilaku defaultnya adalah: Tidak ada untuk penyimpanan Standar. ReadOnly untuk penyimpanan Premium.
createOption	DiskCreateOptionTypes	Menentukan bagaimana disk komputer virtual harus dibuat. Nilai yang mungkin adalah Lampirkan: Nilai ini digunakan saat Anda menggunakan disk khusus untuk membuat komputer virtual. FromImage: Nilai ini digunakan saat Anda menggunakan gambar untuk membuat disk data komputer virtual. Jika Anda menggunakan gambar platform, Anda juga harus menggunakan elemen imageReference yang dijelaskan di atas. Jika Anda menggunakan gambar marketplace, Anda juga harus menggunakan elemen paket yang dijelaskan sebelumnya. Kosong: Nilai ini digunakan saat membuat disk data kosong. Salinan: Nilai ini digunakan untuk membuat disk data dari rekam jepret atau disk lain. Mengembalikan: Nilai ini digunakan untuk membuat disk data dari titik pemulihan disk.
deleteOption	DiskDeleteOptionTypes	Menentukan apakah disk data harus dihapus atau dilepas saat penghapusan VM. Nilai yang mungkin adalah: Hapus. Jika nilai ini digunakan, disk data akan dihapus saat VM dihapus. Melepaskan. Jika nilai ini digunakan, disk data dipertahankan setelah VM dihapus. Nilai default diatur ke Lepaskan.
detachOption	DiskDetachOptionTypes	Menentukan perilaku pencopotan yang akan digunakan saat melepaskan disk atau yang sudah dalam proses pencopotan dari komputer virtual. Nilai yang didukung: ForceDetach. detachOption: ForceDetach hanya berlaku untuk disk data terkelola. Jika upaya pencopotan disk data sebelumnya tidak selesai karena kegagalan tak terduga dari komputer virtual dan disk masih belum dirilis, gunakan force-detach sebagai opsi upaya terakhir untuk melepaskan disk secara paksa dari VM. Semua tulisan mungkin belum dihapus saat menggunakan perilaku lepas ini. Fitur ini masih dalam mode pratinjau dan tidak didukung untuk VirtualMachineScaleSet. Untuk melepaskan paksa pembaruan disk data keBeDetached ke 'true' bersama dengan pengaturan detachOption: 'ForceDetach'.
diskIOPSReadWrite	integer	Menentukan IOPS Read-Write untuk disk terkelola saat StorageAccountType UltraSSD_LRS. Dikembalikan hanya untuk disk VM VirtualMachine ScaleSet. Hanya dapat diperbarui melalui pembaruan ke VirtualMachine Scale Set.
diskMBpsReadWrite	integer	Menentukan bandwidth dalam MB per detik untuk disk terkelola saat StorageAccountType UltraSSD_LRS. Dikembalikan hanya untuk disk VM VirtualMachine ScaleSet. Hanya dapat diperbarui melalui pembaruan ke VirtualMachine Scale Set.
diskSizeGB	integer	Menentukan ukuran disk data kosong dalam gigabyte. Elemen ini dapat digunakan untuk menimpa ukuran disk dalam gambar komputer virtual. Properti 'diskSizeGB' adalah jumlah byte x 1024^3 untuk disk dan nilainya tidak boleh lebih besar dari 1023.
image	VirtualHardDisk	Hard disk virtual gambar pengguna sumber. Hard disk virtual akan disalin sebelum dilampirkan ke komputer virtual. Jika SourceImage disediakan, hard drive virtual tujuan tidak boleh ada.
lun	integer	Menentukan nomor unit logis dari disk data. Nilai ini digunakan untuk mengidentifikasi disk data dalam VM dan oleh karena itu harus unik untuk setiap disk data yang terpasang pada VM.
managedDisk	ManagedDiskParameters	Parameter disk terkelola.
name	string	Nama disk.
sourceResource	ApiEntityReference	Pengidentifikasi sumber daya sumber. Ini bisa menjadi rekam jepret, atau titik pemulihan disk untuk membuat disk.
toBeDetached	boolean	Menentukan apakah disk data sedang dalam proses pencopotan dari VirtualMachine/VirtualMachineScaleset
vhd	VirtualHardDisk	Hard disk virtual.
writeAcceleratorEnabled	boolean	Menentukan apakah writeAccelerator harus diaktifkan atau dinonaktifkan pada disk.

DataDisksToAttach

Daftar disk data terkelola yang akan dilampirkan.

Nama	Jenis	Deskripsi
caching	CachingTypes	Menentukan persyaratan penembolokan. Nilai yang mungkin adalah: None,ReadOnly,ReadWrite. Perilaku defaultnya adalah: Tidak ada untuk penyimpanan Standar. ReadOnly untuk penyimpanan Premium.
deleteOption	DiskDeleteOptionTypes	Menentukan apakah disk data harus dihapus atau dilepas saat penghapusan VM. Nilai yang mungkin adalah: Hapus. Jika nilai ini digunakan, disk data akan dihapus saat VM dihapus. Melepaskan. Jika nilai ini digunakan, disk data dipertahankan setelah VM dihapus. Nilai default diatur ke Lepaskan.
diskEncryptionSet	DiskEncryptionSetParameters	Menentukan id sumber daya set enkripsi disk yang dikelola pelanggan untuk disk terkelola.
diskId	string	ID disk data terkelola.
lun	integer	Nomor unit logis dari disk data. Nilai ini digunakan untuk mengidentifikasi disk data dalam VM dan oleh karena itu harus unik untuk setiap disk data yang terpasang pada VM. Jika tidak ditentukan, lun akan ditetapkan secara otomatis.
writeAcceleratorEnabled	boolean	Menentukan apakah writeAccelerator harus diaktifkan atau dinonaktifkan pada disk.

DataDisksToDetach

Daftar disk data terkelola yang akan dilepaskan.

Nama	Jenis	Deskripsi
detachOption	DiskDetachOptionTypes	Opsi yang didukung tersedia untuk Melepaskan disk dari VM. Lihat referensi objek DetachOption untuk detail selengkapnya.
diskId	string	ID disk data terkelola.

DiffDiskOptions

Menentukan pengaturan disk ephemeral untuk disk sistem operasi.

Nama	Jenis	Deskripsi
Local	string

DiffDiskPlacement

Menentukan penempatan disk ephemeral untuk disk sistem operasi. Nilai yang mungkin adalah: CacheDisk,ResourceDisk,NvmeDisk. Perilaku defaultnya adalah: CacheDisk jika dikonfigurasi untuk ukuran VM jika tidak, ResourceDisk atau NvmeDisk digunakan. Lihat dokumentasi ukuran VM untuk VM Windows di https://docs.microsoft.com/azure/virtual-machines/windows/sizes dan Linux VM di https://docs.microsoft.com/azure/virtual-machines/linux/sizes untuk memeriksa ukuran VM mana yang mengekspos disk cache. Versi api minimum untuk NvmeDisk: 2024-03-01.

Nama	Jenis	Deskripsi
CacheDisk	string
NvmeDisk	string
ResourceDisk	string

DiffDiskSettings

Menentukan Pengaturan Disk ephemeral untuk disk sistem operasi yang digunakan oleh komputer virtual.

Nama	Jenis	Deskripsi
option	DiffDiskOptions	Menentukan pengaturan disk ephemeral untuk disk sistem operasi.
placement	DiffDiskPlacement	Menentukan penempatan disk ephemeral untuk disk sistem operasi. Nilai yang mungkin adalah: CacheDisk,ResourceDisk,NvmeDisk. Perilaku defaultnya adalah: CacheDisk jika dikonfigurasi untuk ukuran VM jika tidak, ResourceDisk atau NvmeDisk digunakan. Lihat dokumentasi ukuran VM untuk VM Windows di https://docs.microsoft.com/azure/virtual-machines/windows/sizes dan Linux VM di https://docs.microsoft.com/azure/virtual-machines/linux/sizes untuk memeriksa ukuran VM mana yang mengekspos disk cache. Versi api minimum untuk NvmeDisk: 2024-03-01.

DiskControllerTypes

Menentukan jenis pengontrol disk yang dikonfigurasi untuk VM. Catatan: Properti ini akan diatur ke jenis pengontrol disk default jika tidak ditentukan asalkan komputer virtual sedang dibuat dengan 'hyperVGeneration' diatur ke V2 berdasarkan kemampuan disk sistem operasi dan ukuran VM dari versi api minimum yang ditentukan. Anda perlu membatalkan alokasi VM sebelum memperbarui jenis pengontrol disknya kecuali Anda memperbarui ukuran VM dalam konfigurasi VM yang secara implisit membatalkan alokasi dan merealokasi VM. Versi api minimum: 2022-08-01.

Nama	Jenis	Deskripsi
NVMe	string
SCSI	string

DiskCreateOptionTypes

Menentukan bagaimana disk komputer virtual harus dibuat. Nilai yang mungkin adalah Lampirkan: Nilai ini digunakan saat Anda menggunakan disk khusus untuk membuat komputer virtual. FromImage: Nilai ini digunakan saat Anda menggunakan gambar untuk membuat komputer virtual. Jika Anda menggunakan gambar platform, Anda juga harus menggunakan elemen imageReference yang dijelaskan di atas. Jika Anda menggunakan gambar marketplace, Anda juga harus menggunakan elemen paket yang dijelaskan sebelumnya.

Nama	Jenis	Deskripsi
Attach	string
Copy	string
Empty	string
FromImage	string
Restore	string

DiskDeleteOptionTypes

Menentukan apakah Disk OS harus dihapus atau dilepas setelah penghapusan VM. Nilai yang mungkin adalah: Hapus. Jika nilai ini digunakan, disk OS dihapus saat VM dihapus. Melepaskan. Jika nilai ini digunakan, disk os dipertahankan setelah VM dihapus. Nilai default diatur ke Lepaskan. Untuk Disk OS sementara, nilai default diatur ke Hapus. Pengguna tidak dapat mengubah opsi hapus untuk Disk OS sementara.

Nama	Jenis	Deskripsi
Delete	string
Detach	string

DiskDetachOptionTypes

Menentukan perilaku pencopotan yang akan digunakan saat melepaskan disk atau yang sudah dalam proses pencopotan dari komputer virtual. Nilai yang didukung: ForceDetach. detachOption: ForceDetach hanya berlaku untuk disk data terkelola. Jika upaya pencopotan disk data sebelumnya tidak selesai karena kegagalan tak terduga dari komputer virtual dan disk masih belum dirilis, gunakan force-detach sebagai opsi upaya terakhir untuk melepaskan disk secara paksa dari VM. Semua tulisan mungkin belum dihapus saat menggunakan perilaku lepas ini. Fitur ini masih dalam mode pratinjau dan tidak didukung untuk VirtualMachineScaleSet. Untuk melepaskan paksa pembaruan disk data keBeDetached ke 'true' bersama dengan pengaturan detachOption: 'ForceDetach'.

Nama	Jenis	Deskripsi
ForceDetach	string

DiskEncryptionSetParameters

Menentukan id sumber daya set enkripsi disk yang dikelola pelanggan untuk disk terkelola.

Nama	Jenis	Deskripsi
id	string	ID sumber daya

DiskEncryptionSettings

Menentukan pengaturan enkripsi untuk Disk OS. Versi api minimum: 2015-06-15.

Nama	Jenis	Deskripsi
diskEncryptionKey	KeyVaultSecretReference	Menentukan lokasi kunci enkripsi disk, yang merupakan Rahasia Key Vault.
enabled	boolean	Menentukan apakah enkripsi disk harus diaktifkan pada komputer virtual.
keyEncryptionKey	KeyVaultKeyReference	Menentukan lokasi kunci enkripsi kunci di Key Vault.

ImageReference

Menentukan informasi tentang gambar yang akan digunakan. Anda dapat menentukan informasi tentang gambar platform, gambar marketplace, atau gambar komputer virtual. Elemen ini diperlukan ketika Anda ingin menggunakan gambar platform, gambar marketplace, atau gambar komputer virtual, tetapi tidak digunakan dalam operasi pembuatan lainnya.

Nama	Jenis	Deskripsi
communityGalleryImageId	string	Menentukan id unik gambar galeri komunitas untuk penyebaran vm. Ini dapat diambil dari panggilan GET gambar galeri komunitas.
exactVersion	string	Menentukan angka desimal, versi gambar platform atau gambar marketplace yang digunakan untuk membuat komputer virtual. Bidang baca-saja ini berbeda dari 'versi', hanya jika nilai yang ditentukan dalam bidang 'versi' adalah 'terbaru'.
id	string	ID sumber daya
offer	string	Menentukan penawaran gambar platform atau gambar marketplace yang digunakan untuk membuat komputer virtual.
publisher	string	Penerbit gambar.
sharedGalleryImageId	string	Menentukan id unik gambar galeri bersama untuk penyebaran vm. Ini dapat diambil dari panggilan GET gambar galeri bersama.
sku	string	SKU gambar.
version	string	Menentukan versi gambar platform atau gambar marketplace yang digunakan untuk membuat komputer virtual. Format yang diizinkan adalah Major.Minor.Build atau 'latest'. Mayor, Minor, dan Build adalah angka desimal. Pilih 'terbaru' untuk menggunakan citra versi terbaru yang tersedia pada waktu penerapan. Bahkan jika Anda menggunakan 'terbaru', gambar VM tidak akan diperbarui secara otomatis setelah waktu penyebaran bahkan jika versi baru tersedia. Jangan gunakan bidang 'versi' untuk penyebaran gambar galeri, gambar galeri harus selalu menggunakan bidang 'id' untuk penyebaran, untuk menggunakan gambar galeri versi 'terbaru', cukup atur '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' di bidang 'id' tanpa input versi.

InnerError

Detail kesalahan dalam.

Nama	Jenis	Deskripsi
errordetail	string	Pesan kesalahan internal atau cadangan pengecualian.
exceptiontype	string	Jenis pengecualian.

KeyVaultKeyReference

Menentukan lokasi kunci enkripsi kunci di Key Vault.

Nama	Jenis	Deskripsi
keyUrl	string	URL yang mereferensikan kunci enkripsi kunci di Key Vault.
sourceVault	SubResource	URL relatif Key Vault yang berisi kunci.

KeyVaultSecretReference

Menentukan lokasi kunci enkripsi disk, yang merupakan Rahasia Key Vault.

Nama	Jenis	Deskripsi
secretUrl	string	URL yang merujuk rahasia dalam Key Vault.
sourceVault	SubResource	URL relatif Key Vault yang berisi rahasia.

ManagedDiskParameters

Parameter disk terkelola.

Nama	Jenis	Deskripsi
diskEncryptionSet	DiskEncryptionSetParameters	Menentukan id sumber daya set enkripsi disk yang dikelola pelanggan untuk disk terkelola.
id	string	ID sumber daya
securityProfile	VMDiskSecurityProfile	Menentukan profil keamanan untuk disk terkelola.
storageAccountType	StorageAccountTypes	Menentukan jenis akun penyimpanan untuk disk terkelola. CATATAN: UltraSSD_LRS hanya dapat digunakan dengan disk data, tidak dapat digunakan dengan Disk OS.

OperatingSystemTypes

Jenis Sistem Operasi.

Nama	Jenis	Deskripsi
Linux	string
Windows	string

OSDisk

Menentukan informasi tentang disk sistem operasi yang digunakan oleh komputer virtual. Untuk informasi selengkapnya tentang disk, lihat Tentang disk dan VHD untuk komputer virtual Azure.

Nama	Jenis	Deskripsi
caching	CachingTypes	Menentukan persyaratan penembolokan. Nilai yang mungkin adalah: None,ReadOnly,ReadWrite. Perilaku defaultnya adalah: Tidak ada untuk penyimpanan Standar. ReadOnly untuk penyimpanan Premium.
createOption	DiskCreateOptionTypes	Menentukan bagaimana disk komputer virtual harus dibuat. Nilai yang mungkin adalah Lampirkan: Nilai ini digunakan saat Anda menggunakan disk khusus untuk membuat komputer virtual. FromImage: Nilai ini digunakan saat Anda menggunakan gambar untuk membuat komputer virtual. Jika Anda menggunakan gambar platform, Anda juga harus menggunakan elemen imageReference yang dijelaskan di atas. Jika Anda menggunakan gambar marketplace, Anda juga harus menggunakan elemen paket yang dijelaskan sebelumnya.
deleteOption	DiskDeleteOptionTypes	Menentukan apakah Disk OS harus dihapus atau dilepas setelah penghapusan VM. Nilai yang mungkin adalah: Hapus. Jika nilai ini digunakan, disk OS dihapus saat VM dihapus. Melepaskan. Jika nilai ini digunakan, disk os dipertahankan setelah VM dihapus. Nilai default diatur ke Lepaskan. Untuk Disk OS sementara, nilai default diatur ke Hapus. Pengguna tidak dapat mengubah opsi hapus untuk Disk OS sementara.
diffDiskSettings	DiffDiskSettings	Menentukan Pengaturan Disk ephemeral untuk disk sistem operasi yang digunakan oleh komputer virtual.
diskSizeGB	integer	Menentukan ukuran disk data kosong dalam gigabyte. Elemen ini dapat digunakan untuk menimpa ukuran disk dalam gambar komputer virtual. Properti 'diskSizeGB' adalah jumlah byte x 1024^3 untuk disk dan nilainya tidak boleh lebih besar dari 1023.
encryptionSettings	DiskEncryptionSettings	Menentukan pengaturan enkripsi untuk Disk OS. Versi api minimum: 2015-06-15.
image	VirtualHardDisk	Hard disk virtual gambar pengguna sumber. Hard disk virtual akan disalin sebelum dilampirkan ke komputer virtual. Jika SourceImage disediakan, hard drive virtual tujuan tidak boleh ada.
managedDisk	ManagedDiskParameters	Parameter disk terkelola.
name	string	Nama disk.
osType	OperatingSystemTypes	Properti ini memungkinkan Anda menentukan jenis OS yang disertakan dalam disk jika membuat VM dari gambar pengguna atau VHD khusus. Nilai yang mungkin adalah: Windows,Linux.
vhd	VirtualHardDisk	Hard disk virtual.
writeAcceleratorEnabled	boolean	Menentukan apakah writeAccelerator harus diaktifkan atau dinonaktifkan pada disk.

securityEncryptionTypes

Menentukan EncryptionType dari disk terkelola. Ini diatur ke DiskWithVMGuestState untuk enkripsi disk terkelola bersama dengan blob VMGuestState, VMGuestStateOnly untuk enkripsi hanya blob VMGuestState, dan NonPersistedTPM untuk tidak mempertahankan status firmware di blob VMGuestState.. Catatan: Ini hanya dapat diatur untuk VM Rahasia.

Nama	Jenis	Deskripsi
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

StorageAccountTypes

Menentukan jenis akun penyimpanan untuk disk terkelola. CATATAN: UltraSSD_LRS hanya dapat digunakan dengan disk data, tidak dapat digunakan dengan Disk OS.

Nama	Jenis	Deskripsi
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

StorageProfile

Menentukan pengaturan penyimpanan untuk disk komputer virtual.

Nama	Jenis	Deskripsi
dataDisks	DataDisk[]	Menentukan parameter yang digunakan untuk menambahkan disk data ke komputer virtual. Untuk informasi selengkapnya tentang disk, lihat Tentang disk dan VHD untuk komputer virtual Azure.
diskControllerType	DiskControllerTypes	Menentukan jenis pengontrol disk yang dikonfigurasi untuk VM. Catatan: Properti ini akan diatur ke jenis pengontrol disk default jika tidak ditentukan asalkan komputer virtual sedang dibuat dengan 'hyperVGeneration' diatur ke V2 berdasarkan kemampuan disk sistem operasi dan ukuran VM dari versi api minimum yang ditentukan. Anda perlu membatalkan alokasi VM sebelum memperbarui jenis pengontrol disknya kecuali Anda memperbarui ukuran VM dalam konfigurasi VM yang secara implisit membatalkan alokasi dan merealokasi VM. Versi api minimum: 2022-08-01.
imageReference	ImageReference	Menentukan informasi tentang gambar yang akan digunakan. Anda dapat menentukan informasi tentang gambar platform, gambar marketplace, atau gambar komputer virtual. Elemen ini diperlukan ketika Anda ingin menggunakan gambar platform, gambar marketplace, atau gambar komputer virtual, tetapi tidak digunakan dalam operasi pembuatan lainnya.
osDisk	OSDisk	Menentukan informasi tentang disk sistem operasi yang digunakan oleh komputer virtual. Untuk informasi selengkapnya tentang disk, lihat Tentang disk dan VHD untuk komputer virtual Azure.

SubResource

Nama	Jenis	Deskripsi
id	string	ID sumber daya

VirtualHardDisk

Hard disk virtual.

Nama	Jenis	Deskripsi
uri	string	Menentukan uri hard disk virtual.

VMDiskSecurityProfile

Menentukan profil keamanan untuk disk terkelola.

Nama	Jenis	Deskripsi
diskEncryptionSet	DiskEncryptionSetParameters	Menentukan id sumber daya set enkripsi disk yang dikelola pelanggan untuk disk terkelola yang digunakan untuk Disk OS ConfidentialVM terkelola Kunci Terkelola Pelanggan dan blob VMGuest.
securityEncryptionType	securityEncryptionTypes	Menentukan EncryptionType dari disk terkelola. Ini diatur ke DiskWithVMGuestState untuk enkripsi disk terkelola bersama dengan blob VMGuestState, VMGuestStateOnly untuk enkripsi hanya blob VMGuestState, dan NonPersistedTPM untuk tidak mempertahankan status firmware di blob VMGuestState.. Catatan: Ini hanya dapat diatur untuk VM Rahasia.