Virtual Machine Scale Set VMs - Attach Detach Data Disks

Service:

Compute

API Version:

2024-03-01

Anexe e desanexe discos de dados de/para uma máquina virtual em um conjunto de dimensionamento de VMs.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
instanceId	path	True	string	A ID da instância da máquina virtual.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
vmScaleSetName	path	True	string	O nome do conjunto de dimensionamento da VM.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

Nome	Tipo	Description
parameters	AttachDetachDataDisksRequest	Parâmetros fornecidos para a operação de anexação e desanexação de discos de dados em uma VM Conjuntos de Dimensionamento de Máquinas Virtuais.

Respostas

Nome	Tipo	Description
200 OK	StorageProfile	OK
202 Accepted		Aceito Headers Location: string
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Definições

Nome	Description
ApiEntityReference	O identificador de recurso de origem. Pode ser uma instantâneo ou um ponto de restauração de disco do qual criar um disco.
ApiError	Erro de API.
ApiErrorBase	Base de erros de API.
AttachDetachDataDisksRequest	Parâmetros fornecidos para a operação de anexação e desanexação de discos de dados em uma VM Conjuntos de Dimensionamento de Máquinas Virtuais.
CachingTypes	Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnly,ReadWrite. O comportamento padrão é: Nenhum para armazenamento Standard. ReadOnly para armazenamento Premium.
CloudError	Uma resposta de erro do serviço de computação.
DataDisk	Especifica os parâmetros que são usados para adicionar um disco de dados a uma máquina virtual. Para obter mais informações sobre discos, consulte Sobre discos e VHDs para máquinas virtuais do Azure.
DataDisksToAttach	A lista de discos de dados gerenciados a serem anexados.
DataDisksToDetach	A lista de discos de dados gerenciados a serem desanexados.
DiffDiskOptions	Especifica as configurações de disco efêmero para o disco do sistema operacional.
DiffDiskPlacement	Especifica o posicionamento de disco efêmero para o disco do sistema operacional. Os valores possíveis são: CacheDisk,ResourceDisk,NvmeDisk. O comportamento padrão é: CacheDisk se um estiver configurado para o tamanho da VM, caso contrário, ResourceDisk ou NvmeDisk será usado. Consulte a documentação de tamanho da VM para VM do Windows em https://docs.microsoft.com/azure/virtual-machines/windows/sizes e VM do Linux em https://docs.microsoft.com/azure/virtual-machines/linux/sizes para marcar quais tamanhos de VM expõem um disco de cache. Versão mínima da API para NvmeDisk: 2024-03-01.
DiffDiskSettings	Especifica as Configurações de Disco efêmero para o disco do sistema operacional usado pela máquina virtual.
DiskControllerTypes	Especifica o tipo de controlador de disco configurado para a VM. Nota: Essa propriedade será definida como o tipo de controlador de disco padrão se não for especificada, desde que a máquina virtual esteja sendo criada com 'hyperVGeneration' definido como V2 com base nos recursos do disco do sistema operacional e do tamanho da VM da versão mínima da API especificada. Você precisa desalocar a VM antes de atualizar seu tipo de controlador de disco, a menos que esteja atualizando o tamanho da VM na configuração da VM que desaloca e realoca implicitamente a VM. Versão mínima da api: 2022-08-01.
DiskCreateOptionTypes	Especifica como o disco da máquina virtual deve ser criado. Os valores possíveis são Anexar: esse valor é usado quando você está usando um disco especializado para criar a máquina virtual. Fromimage: Esse valor é usado quando você está usando uma imagem para criar a máquina virtual. Se você estiver usando uma imagem de plataforma, também deverá usar o elemento imageReference descrito acima. Se você estiver usando uma imagem do marketplace, também deverá usar o elemento de plano descrito anteriormente.
DiskDeleteOptionTypes	Especifica se o disco do sistema operacional deve ser excluído ou desanexado após a exclusão da VM. Os valores possíveis são: Excluir. Se esse valor for usado, o disco do sistema operacional será excluído quando a VM for excluída. Desanexar. Se esse valor for usado, o disco do sistema operacional será retido depois que a VM for excluída. O valor padrão é definido como Desanexar. Para um Disco do SO efêmero, o valor padrão é definido como Excluir. O usuário não pode alterar a opção de exclusão para um disco do sistema operacional efêmero.
DiskDetachOptionTypes	Especifica o comportamento de desanexação a ser usado durante a desanexação de um disco ou que já está em processo de desanexação da máquina virtual. Valores com suporte: ForceDetach. detachOption: ForceDetach é aplicável somente para discos de dados gerenciados. Se uma tentativa de desanexação anterior do disco de dados não foi concluída devido a uma falha inesperada da máquina virtual e o disco ainda não foi liberado, use force-detach como uma opção de último recurso para desanexar o disco à força da VM. Todas as gravações podem não ter sido liberadas ao usar esse comportamento de desanexação. Esse recurso ainda está no modo de visualização e não tem suporte para VirtualMachineScaleSet. Para forçar a desanexação de uma atualização de disco de dados paraBeDetached como 'true' juntamente com a configuração detachOption: 'ForceDetach'.
DiskEncryptionSetParameters	Especifica a ID do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado.
DiskEncryptionSettings	Especifica as configurações de criptografia para o disco do sistema operacional. Versão mínima da api: 2015-06-15.
ImageReference	Especifica informações sobre a imagem a ser usada. Você pode especificar informações sobre imagens de plataforma, imagens do marketplace ou imagens de máquina virtual. Esse elemento é necessário quando você deseja usar uma imagem de plataforma, uma imagem do marketplace ou uma imagem de máquina virtual, mas não é usado em outras operações de criação.
InnerError	Detalhes do erro interno.
KeyVaultKeyReference	Especifica o local da chave de criptografia de chave no Key Vault.
KeyVaultSecretReference	Especifica o local da chave de criptografia de disco, que é um segredo Key Vault.
ManagedDiskParameters	Os parâmetros de disco gerenciado.
OperatingSystemTypes	O tipo de sistema operacional.
OSDisk	Especifica informações sobre o disco do sistema operacional usado pela máquina virtual. Para obter mais informações sobre discos, consulte Sobre discos e VHDs para máquinas virtuais do Azure.
securityEncryptionTypes	Especifica o EncryptionType do disco gerenciado. Ele é definido como DiskWithVMGuestState para criptografia do disco gerenciado juntamente com o blob VMGuestState, VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado do firmware no blob VMGuestState.. Nota: Ele pode ser definido apenas para VMs confidenciais.
StorageAccountTypes	Especifica o tipo de conta de armazenamento para o disco gerenciado. OBSERVAÇÃO: UltraSSD_LRS só pode ser usado com discos de dados, ele não pode ser usado com o disco do sistema operacional.
StorageProfile	Especifica as configurações de armazenamento dos discos da máquina virtual.
SubResource
VirtualHardDisk	O disco rígido virtual.
VMDiskSecurityProfile	Especifica o perfil de segurança para o disco gerenciado.

ApiEntityReference

O identificador de recurso de origem. Pode ser uma instantâneo ou um ponto de restauração de disco do qual criar um disco.

Nome	Tipo	Description
id	string	A ID do recurso do ARM na forma de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Erro de API.

Nome	Tipo	Description
code	string	O código de erro.
details	ApiErrorBase[]	Os detalhes do erro da API
innererror	InnerError	O erro interno da API
message	string	A mensagem de erro.
target	string	O destino do erro específico.

ApiErrorBase

Base de erros de API.

Nome	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro.
target	string	O destino do erro específico.

AttachDetachDataDisksRequest

Parâmetros fornecidos para a operação de anexação e desanexação de discos de dados em uma VM Conjuntos de Dimensionamento de Máquinas Virtuais.

Nome	Tipo	Description
dataDisksToAttach	DataDisksToAttach[]	A lista de discos de dados gerenciados a serem anexados.
dataDisksToDetach	DataDisksToDetach[]	A lista de discos de dados gerenciados a serem desanexados.

CachingTypes

Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnly,ReadWrite. O comportamento padrão é: Nenhum para armazenamento Standard. ReadOnly para armazenamento Premium.

Nome	Tipo	Description
None	string
ReadOnly	string
ReadWrite	string

CloudError

Uma resposta de erro do serviço de computação.

Nome	Tipo	Description
error	ApiError	Erro de API.

DataDisk

Especifica os parâmetros que são usados para adicionar um disco de dados a uma máquina virtual. Para obter mais informações sobre discos, consulte Sobre discos e VHDs para máquinas virtuais do Azure.

Nome	Tipo	Description
caching	CachingTypes	Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnly,ReadWrite. O comportamento padrão é: Nenhum para armazenamento Standard. ReadOnly para armazenamento Premium.
createOption	DiskCreateOptionTypes	Especifica como o disco da máquina virtual deve ser criado. Os valores possíveis são Anexar: esse valor é usado quando você está usando um disco especializado para criar a máquina virtual. Fromimage: Esse valor é usado quando você está usando uma imagem para criar o disco de dados da máquina virtual. Se você estiver usando uma imagem de plataforma, também deverá usar o elemento imageReference descrito acima. Se você estiver usando uma imagem do marketplace, também deverá usar o elemento de plano descrito anteriormente. Vazio: Esse valor é usado ao criar um disco de dados vazio. Cópia: Esse valor é usado para criar um disco de dados de um instantâneo ou outro disco. Restaurar: Esse valor é usado para criar um disco de dados de um ponto de restauração de disco.
deleteOption	DiskDeleteOptionTypes	Especifica se o disco de dados deve ser excluído ou desanexado após a exclusão da VM. Os valores possíveis são: Excluir. Se esse valor for usado, o disco de dados será excluído quando a VM for excluída. Desanexar. Se esse valor for usado, o disco de dados será retido depois que a VM for excluída. O valor padrão é definido como Desanexar.
detachOption	DiskDetachOptionTypes	Especifica o comportamento de desanexação a ser usado durante a desanexação de um disco ou que já está em processo de desanexação da máquina virtual. Valores com suporte: ForceDetach. detachOption: ForceDetach é aplicável somente para discos de dados gerenciados. Se uma tentativa de desanexação anterior do disco de dados não foi concluída devido a uma falha inesperada da máquina virtual e o disco ainda não foi liberado, use force-detach como uma opção de último recurso para desanexar o disco à força da VM. Todas as gravações podem não ter sido liberadas ao usar esse comportamento de desanexação. Esse recurso ainda está no modo de visualização e não tem suporte para VirtualMachineScaleSet. Para forçar a desanexação de uma atualização de disco de dados paraBeDetached como 'true' juntamente com a configuração detachOption: 'ForceDetach'.
diskIOPSReadWrite	integer	Especifica o Read-Write IOPS para o disco gerenciado quando StorageAccountType é UltraSSD_LRS. Retornado somente para discos de VM VirtualMachine ScaleSet. Só pode ser atualizado por meio de atualizações para o Conjunto de Dimensionamento virtualMachine.
diskMBpsReadWrite	integer	Especifica a largura de banda em MB por segundo para o disco gerenciado quando StorageAccountType é UltraSSD_LRS. Retornado somente para discos de VM VirtualMachine ScaleSet. Só pode ser atualizado por meio de atualizações para o Conjunto de Dimensionamento virtualMachine.
diskSizeGB	integer	Especifica o tamanho de um disco de dados vazio em gigabytes. Esse elemento pode ser usado para substituir o tamanho do disco em uma imagem de máquina virtual. A propriedade 'diskSizeGB' é o número de bytes x 1024^3 para o disco e o valor não pode ser maior que 1023.
image	VirtualHardDisk	O disco rígido virtual da imagem do usuário de origem. O disco rígido virtual será copiado antes de ser anexado à máquina virtual. Se SourceImage for fornecido, o disco rígido virtual de destino não deverá existir.
lun	integer	Especifica o número da unidade lógica do disco de dados. Esse valor é usado para identificar discos de dados dentro da VM e, portanto, deve ser exclusivo para cada disco de dados anexado a uma VM.
managedDisk	ManagedDiskParameters	Os parâmetros de disco gerenciado.
name	string	O nome do disco.
sourceResource	ApiEntityReference	O identificador de recurso de origem. Pode ser uma instantâneo ou um ponto de restauração de disco do qual criar um disco.
toBeDetached	boolean	Especifica se o disco de dados está em processo de desanexação do VirtualMachine/VirtualMachineScaleset
vhd	VirtualHardDisk	O disco rígido virtual.
writeAcceleratorEnabled	boolean	Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco.

DataDisksToAttach

A lista de discos de dados gerenciados a serem anexados.

Nome	Tipo	Description
caching	CachingTypes	Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnly,ReadWrite. O comportamento padrão é: Nenhum para armazenamento Standard. ReadOnly para armazenamento Premium.
deleteOption	DiskDeleteOptionTypes	Especifica se o disco de dados deve ser excluído ou desanexado após a exclusão da VM. Os valores possíveis são: Excluir. Se esse valor for usado, o disco de dados será excluído quando a VM for excluída. Desanexar. Se esse valor for usado, o disco de dados será retido depois que a VM for excluída. O valor padrão é definido como Desanexar.
diskEncryptionSet	DiskEncryptionSetParameters	Especifica a ID do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado.
diskId	string	ID do disco de dados gerenciado.
lun	integer	O número da unidade lógica do disco de dados. Esse valor é usado para identificar discos de dados dentro da VM e, portanto, deve ser exclusivo para cada disco de dados anexado a uma VM. Se não for especificado, lun será atribuído automaticamente.
writeAcceleratorEnabled	boolean	Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco.

DataDisksToDetach

A lista de discos de dados gerenciados a serem desanexados.

Nome	Tipo	Description
detachOption	DiskDetachOptionTypes	Opções com suporte disponíveis para Desanexar um disco de uma VM. Consulte Referência de objeto DetachOption para obter mais detalhes.
diskId	string	ID do disco de dados gerenciado.

DiffDiskOptions

Especifica as configurações de disco efêmero para o disco do sistema operacional.

Nome	Tipo	Description
Local	string

DiffDiskPlacement

Especifica o posicionamento de disco efêmero para o disco do sistema operacional. Os valores possíveis são: CacheDisk,ResourceDisk,NvmeDisk. O comportamento padrão é: CacheDisk se um estiver configurado para o tamanho da VM, caso contrário, ResourceDisk ou NvmeDisk será usado. Consulte a documentação de tamanho da VM para VM do Windows em https://docs.microsoft.com/azure/virtual-machines/windows/sizes e VM do Linux em https://docs.microsoft.com/azure/virtual-machines/linux/sizes para marcar quais tamanhos de VM expõem um disco de cache. Versão mínima da API para NvmeDisk: 2024-03-01.

Nome	Tipo	Description
CacheDisk	string
NvmeDisk	string
ResourceDisk	string

DiffDiskSettings

Especifica as Configurações de Disco efêmero para o disco do sistema operacional usado pela máquina virtual.

Nome	Tipo	Description
option	DiffDiskOptions	Especifica as configurações de disco efêmero para o disco do sistema operacional.
placement	DiffDiskPlacement	Especifica o posicionamento de disco efêmero para o disco do sistema operacional. Os valores possíveis são: CacheDisk,ResourceDisk,NvmeDisk. O comportamento padrão é: CacheDisk se um estiver configurado para o tamanho da VM, caso contrário, ResourceDisk ou NvmeDisk será usado. Consulte a documentação de tamanho da VM para VM do Windows em https://docs.microsoft.com/azure/virtual-machines/windows/sizes e VM do Linux em https://docs.microsoft.com/azure/virtual-machines/linux/sizes para marcar quais tamanhos de VM expõem um disco de cache. Versão mínima da API para NvmeDisk: 2024-03-01.

DiskControllerTypes

Especifica o tipo de controlador de disco configurado para a VM. Nota: Essa propriedade será definida como o tipo de controlador de disco padrão se não for especificada, desde que a máquina virtual esteja sendo criada com 'hyperVGeneration' definido como V2 com base nos recursos do disco do sistema operacional e do tamanho da VM da versão mínima da API especificada. Você precisa desalocar a VM antes de atualizar seu tipo de controlador de disco, a menos que esteja atualizando o tamanho da VM na configuração da VM que desaloca e realoca implicitamente a VM. Versão mínima da api: 2022-08-01.

Nome	Tipo	Description
NVMe	string
SCSI	string

DiskCreateOptionTypes

Especifica como o disco da máquina virtual deve ser criado. Os valores possíveis são Anexar: esse valor é usado quando você está usando um disco especializado para criar a máquina virtual. Fromimage: Esse valor é usado quando você está usando uma imagem para criar a máquina virtual. Se você estiver usando uma imagem de plataforma, também deverá usar o elemento imageReference descrito acima. Se você estiver usando uma imagem do marketplace, também deverá usar o elemento de plano descrito anteriormente.

Nome	Tipo	Description
Attach	string
Copy	string
Empty	string
FromImage	string
Restore	string

DiskDeleteOptionTypes

Especifica se o disco do sistema operacional deve ser excluído ou desanexado após a exclusão da VM. Os valores possíveis são: Excluir. Se esse valor for usado, o disco do sistema operacional será excluído quando a VM for excluída. Desanexar. Se esse valor for usado, o disco do sistema operacional será retido depois que a VM for excluída. O valor padrão é definido como Desanexar. Para um Disco do SO efêmero, o valor padrão é definido como Excluir. O usuário não pode alterar a opção de exclusão para um disco do sistema operacional efêmero.

Nome	Tipo	Description
Delete	string
Detach	string

DiskDetachOptionTypes

Especifica o comportamento de desanexação a ser usado durante a desanexação de um disco ou que já está em processo de desanexação da máquina virtual. Valores com suporte: ForceDetach. detachOption: ForceDetach é aplicável somente para discos de dados gerenciados. Se uma tentativa de desanexação anterior do disco de dados não foi concluída devido a uma falha inesperada da máquina virtual e o disco ainda não foi liberado, use force-detach como uma opção de último recurso para desanexar o disco à força da VM. Todas as gravações podem não ter sido liberadas ao usar esse comportamento de desanexação. Esse recurso ainda está no modo de visualização e não tem suporte para VirtualMachineScaleSet. Para forçar a desanexação de uma atualização de disco de dados paraBeDetached como 'true' juntamente com a configuração detachOption: 'ForceDetach'.

Nome	Tipo	Description
ForceDetach	string

DiskEncryptionSetParameters

Especifica a ID do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado.

Nome	Tipo	Description
id	string	ID do recurso

DiskEncryptionSettings

Especifica as configurações de criptografia para o disco do sistema operacional. Versão mínima da api: 2015-06-15.

Nome	Tipo	Description
diskEncryptionKey	KeyVaultSecretReference	Especifica o local da chave de criptografia de disco, que é um segredo Key Vault.
enabled	boolean	Especifica se a criptografia de disco deve ser habilitada na máquina virtual.
keyEncryptionKey	KeyVaultKeyReference	Especifica o local da chave de criptografia de chave no Key Vault.

ImageReference

Especifica informações sobre a imagem a ser usada. Você pode especificar informações sobre imagens de plataforma, imagens do marketplace ou imagens de máquina virtual. Esse elemento é necessário quando você deseja usar uma imagem de plataforma, uma imagem do marketplace ou uma imagem de máquina virtual, mas não é usado em outras operações de criação.

Nome	Tipo	Description
communityGalleryImageId	string	Especificamos a ID exclusiva da imagem da galeria da comunidade para implantação de VM. Isso pode ser buscado na chamada GET da imagem da galeria da comunidade.
exactVersion	string	Especifica em números decimais, a versão da imagem da plataforma ou da imagem do marketplace usada para criar a máquina virtual. Esse campo somente leitura difere de 'version', somente se o valor especificado no campo 'version' for 'latest'.
id	string	ID do recurso
offer	string	Especifica a oferta da imagem da plataforma ou da imagem do marketplace usada para criar a máquina virtual.
publisher	string	O editor de imagens.
sharedGalleryImageId	string	Especificamos a ID exclusiva da imagem da galeria compartilhada para implantação de VM. Isso pode ser buscado na chamada GET da imagem da galeria compartilhada.
sku	string	A SKU da imagem.
version	string	Especifica a versão da imagem da plataforma ou da imagem do marketplace usada para criar a máquina virtual. Os formatos permitidos são Major.Minor.Build ou 'latest'. Major, Minor e Build são números decimais. Especifique 'mais recente' para usar a versão mais recente de uma imagem disponível no momento da implantação. Mesmo que você use "mais recente", a imagem da VM não será atualizada automaticamente após o tempo de implantação, mesmo que uma nova versão fique disponível. Não use o campo 'version' para implantação de imagem da galeria, a imagem da galeria sempre deve usar o campo 'id' para implantação, para usar a versão 'mais recente' da imagem da galeria, basta definir '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' no campo 'id' sem entrada de versão.

InnerError

Detalhes do erro interno.

Nome	Tipo	Description
errordetail	string	A mensagem de erro interna ou o despejo de exceção.
exceptiontype	string	O tipo de exceção.

KeyVaultKeyReference

Especifica o local da chave de criptografia de chave no Key Vault.

Nome	Tipo	Description
keyUrl	string	A URL que faz referência a uma chave de criptografia de chave no Key Vault.
sourceVault	SubResource	A URL relativa do Key Vault que contém a chave.

KeyVaultSecretReference

Especifica o local da chave de criptografia de disco, que é um segredo Key Vault.

Nome	Tipo	Description
secretUrl	string	A URL que faz referência a um segredo em um Key Vault.
sourceVault	SubResource	A URL relativa do Key Vault que contém o segredo.

ManagedDiskParameters

Os parâmetros de disco gerenciado.

Nome	Tipo	Description
diskEncryptionSet	DiskEncryptionSetParameters	Especifica a ID do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado.
id	string	ID do recurso
securityProfile	VMDiskSecurityProfile	Especifica o perfil de segurança para o disco gerenciado.
storageAccountType	StorageAccountTypes	Especifica o tipo de conta de armazenamento para o disco gerenciado. OBSERVAÇÃO: UltraSSD_LRS só pode ser usado com discos de dados, ele não pode ser usado com o disco do sistema operacional.

OperatingSystemTypes

O tipo de sistema operacional.

Nome	Tipo	Description
Linux	string
Windows	string

OSDisk

Especifica informações sobre o disco do sistema operacional usado pela máquina virtual. Para obter mais informações sobre discos, consulte Sobre discos e VHDs para máquinas virtuais do Azure.

Nome	Tipo	Description
caching	CachingTypes	Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnly,ReadWrite. O comportamento padrão é: Nenhum para armazenamento Standard. ReadOnly para armazenamento Premium.
createOption	DiskCreateOptionTypes	Especifica como o disco da máquina virtual deve ser criado. Os valores possíveis são Anexar: esse valor é usado quando você está usando um disco especializado para criar a máquina virtual. Fromimage: Esse valor é usado quando você está usando uma imagem para criar a máquina virtual. Se você estiver usando uma imagem de plataforma, também deverá usar o elemento imageReference descrito acima. Se você estiver usando uma imagem do marketplace, também deverá usar o elemento de plano descrito anteriormente.
deleteOption	DiskDeleteOptionTypes	Especifica se o disco do sistema operacional deve ser excluído ou desanexado após a exclusão da VM. Os valores possíveis são: Excluir. Se esse valor for usado, o disco do sistema operacional será excluído quando a VM for excluída. Desanexar. Se esse valor for usado, o disco do sistema operacional será retido depois que a VM for excluída. O valor padrão é definido como Desanexar. Para um Disco do SO efêmero, o valor padrão é definido como Excluir. O usuário não pode alterar a opção de exclusão para um disco do sistema operacional efêmero.
diffDiskSettings	DiffDiskSettings	Especifica as Configurações de Disco efêmero para o disco do sistema operacional usado pela máquina virtual.
diskSizeGB	integer	Especifica o tamanho de um disco de dados vazio em gigabytes. Esse elemento pode ser usado para substituir o tamanho do disco em uma imagem de máquina virtual. A propriedade 'diskSizeGB' é o número de bytes x 1024^3 para o disco e o valor não pode ser maior que 1023.
encryptionSettings	DiskEncryptionSettings	Especifica as configurações de criptografia para o disco do sistema operacional. Versão mínima da api: 2015-06-15.
image	VirtualHardDisk	O disco rígido virtual da imagem do usuário de origem. O disco rígido virtual será copiado antes de ser anexado à máquina virtual. Se SourceImage for fornecido, o disco rígido virtual de destino não deverá existir.
managedDisk	ManagedDiskParameters	Os parâmetros de disco gerenciado.
name	string	O nome do disco.
osType	OperatingSystemTypes	Essa propriedade permite que você especifique o tipo do sistema operacional incluído no disco se estiver criando uma VM com base na imagem do usuário ou em um VHD especializado. Os valores possíveis são: Windows,Linux.
vhd	VirtualHardDisk	O disco rígido virtual.
writeAcceleratorEnabled	boolean	Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco.

securityEncryptionTypes

Especifica o EncryptionType do disco gerenciado. Ele é definido como DiskWithVMGuestState para criptografia do disco gerenciado juntamente com o blob VMGuestState, VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado do firmware no blob VMGuestState.. Nota: Ele pode ser definido apenas para VMs confidenciais.

Nome	Tipo	Description
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

StorageAccountTypes

Especifica o tipo de conta de armazenamento para o disco gerenciado. OBSERVAÇÃO: UltraSSD_LRS só pode ser usado com discos de dados, ele não pode ser usado com o disco do sistema operacional.

Nome	Tipo	Description
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

StorageProfile

Especifica as configurações de armazenamento dos discos da máquina virtual.

Nome	Tipo	Description
dataDisks	DataDisk[]	Especifica os parâmetros que são usados para adicionar um disco de dados a uma máquina virtual. Para obter mais informações sobre discos, consulte Sobre discos e VHDs para máquinas virtuais do Azure.
diskControllerType	DiskControllerTypes	Especifica o tipo de controlador de disco configurado para a VM. Nota: Essa propriedade será definida como o tipo de controlador de disco padrão se não for especificada, desde que a máquina virtual esteja sendo criada com 'hyperVGeneration' definido como V2 com base nos recursos do disco do sistema operacional e do tamanho da VM da versão mínima da API especificada. Você precisa desalocar a VM antes de atualizar seu tipo de controlador de disco, a menos que esteja atualizando o tamanho da VM na configuração da VM que desaloca e realoca implicitamente a VM. Versão mínima da api: 2022-08-01.
imageReference	ImageReference	Especifica informações sobre a imagem a ser usada. Você pode especificar informações sobre imagens de plataforma, imagens do marketplace ou imagens de máquina virtual. Esse elemento é necessário quando você deseja usar uma imagem de plataforma, uma imagem do marketplace ou uma imagem de máquina virtual, mas não é usado em outras operações de criação.
osDisk	OSDisk	Especifica informações sobre o disco do sistema operacional usado pela máquina virtual. Para obter mais informações sobre discos, consulte Sobre discos e VHDs para máquinas virtuais do Azure.

SubResource

Nome	Tipo	Description
id	string	ID do recurso

VirtualHardDisk

O disco rígido virtual.

Nome	Tipo	Description
uri	string	Especifica o URI do disco rígido virtual.

VMDiskSecurityProfile

Especifica o perfil de segurança para o disco gerenciado.

Nome	Tipo	Description
diskEncryptionSet	DiskEncryptionSetParameters	Especifica a ID do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado que é usado para a Chave Gerenciada pelo Cliente criptografado Disco do SO ConfidentialVM e blob VMGuest.
securityEncryptionType	securityEncryptionTypes	Especifica o EncryptionType do disco gerenciado. Ele é definido como DiskWithVMGuestState para criptografia do disco gerenciado juntamente com o blob VMGuestState, VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado do firmware no blob VMGuestState.. Nota: Ele pode ser definido apenas para VMs confidenciais.