Virtual Machines - Attach Detach Data Disks

Serviço:

Compute

Versão da API:

2024-07-01

Anexe e desanexe discos de dados de/para a máquina virtual.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
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. O ID da assinatura faz parte do URI de cada chamada de serviço.
vmName	path	True	string	O nome da máquina virtual.
api-version	query	True	string	Versão da API do cliente.

Corpo do Pedido

Name	Tipo	Description
parameters	AttachDetachDataDisksRequest	Parâmetros fornecidos para a operação anexar e desanexar discos de dados na máquina virtual.

Respostas

Name	Tipo	Description
200 OK	StorageProfile	OK
202 Accepted		Aceito Cabeçalhos Location: string
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

Pedido de amostra

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/aaaaaaaaaaaaaaaaaaaa/attachDetachDataDisks?api-version=2024-07-01

{
  "dataDisksToAttach": [
    {
      "lun": 1,
      "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
      "diskEncryptionSet": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
      },
      "caching": "ReadOnly",
      "deleteOption": "Delete",
      "writeAcceleratorEnabled": true
    },
    {
      "lun": 2,
      "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e",
      "diskEncryptionSet": {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
      },
      "caching": "ReadWrite",
      "deleteOption": "Detach",
      "writeAcceleratorEnabled": false
    }
  ],
  "dataDisksToDetach": [
    {
      "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x",
      "detachOption": "ForceDetach"
    },
    {
      "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_4_disk4_4d4e784bdafa49baa780eb2d256ff41z",
      "detachOption": "ForceDetach"
    }
  ]
}

Java

import com.azure.resourcemanager.compute.models.AttachDetachDataDisksRequest;
import com.azure.resourcemanager.compute.models.CachingTypes;
import com.azure.resourcemanager.compute.models.DataDisksToAttach;
import com.azure.resourcemanager.compute.models.DataDisksToDetach;
import com.azure.resourcemanager.compute.models.DiskDeleteOptionTypes;
import com.azure.resourcemanager.compute.models.DiskDetachOptionTypes;
import com.azure.resourcemanager.compute.models.DiskEncryptionSetParameters;
import java.util.Arrays;

/**
 * Samples for VirtualMachines AttachDetachDataDisks.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        virtualMachineAttachDetachDataDisksMaximumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines().attachDetachDataDisks("rgcompute",
            "aaaaaaaaaaaaaaaaaaaa",
            new AttachDetachDataDisksRequest().withDataDisksToAttach(Arrays.asList(new DataDisksToAttach().withDiskId(
                "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d")
                .withLun(1).withCaching(CachingTypes.READ_ONLY).withDeleteOption(DiskDeleteOptionTypes.DELETE)
                .withDiskEncryptionSet(new DiskEncryptionSetParameters().withId(
                    "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"))
                .withWriteAcceleratorEnabled(true),
                new DataDisksToAttach().withDiskId(
                    "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e")
                    .withLun(2).withCaching(CachingTypes.READ_WRITE).withDeleteOption(DiskDeleteOptionTypes.DETACH)
                    .withDiskEncryptionSet(new DiskEncryptionSetParameters().withId(
                        "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"))
                    .withWriteAcceleratorEnabled(false)))
                .withDataDisksToDetach(Arrays.asList(new DataDisksToDetach().withDiskId(
                    "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x")
                    .withDetachOption(DiskDetachOptionTypes.FORCE_DETACH),
                    new DataDisksToDetach().withDiskId(
                        "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_4_disk4_4d4e784bdafa49baa780eb2d256ff41z")
                        .withDetachOption(DiskDetachOptionTypes.FORCE_DETACH))),
            com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_attach_detach_data_disks_maximum_set_gen.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.virtual_machines.begin_attach_detach_data_disks(
        resource_group_name="rgcompute",
        vm_name="aaaaaaaaaaaaaaaaaaaa",
        parameters={
            "dataDisksToAttach": [
                {
                    "caching": "ReadOnly",
                    "deleteOption": "Delete",
                    "diskEncryptionSet": {
                        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
                    },
                    "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
                    "lun": 1,
                    "writeAcceleratorEnabled": True,
                },
                {
                    "caching": "ReadWrite",
                    "deleteOption": "Detach",
                    "diskEncryptionSet": {
                        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
                    },
                    "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e",
                    "lun": 2,
                    "writeAcceleratorEnabled": False,
                },
            ],
            "dataDisksToDetach": [
                {
                    "detachOption": "ForceDetach",
                    "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x",
                },
                {
                    "detachOption": "ForceDetach",
                    "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_4_disk4_4d4e784bdafa49baa780eb2d256ff41z",
                },
            ],
        },
    ).result()
    print(response)


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

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

Go

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.json
func ExampleVirtualMachinesClient_BeginAttachDetachDataDisks_virtualMachineAttachDetachDataDisksMaximumSetGen() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVirtualMachinesClient().BeginAttachDetachDataDisks(ctx, "rgcompute", "aaaaaaaaaaaaaaaaaaaa", armcompute.AttachDetachDataDisksRequest{
		DataDisksToAttach: []*armcompute.DataDisksToAttach{
			{
				Caching:      to.Ptr(armcompute.CachingTypesReadOnly),
				DeleteOption: to.Ptr(armcompute.DiskDeleteOptionTypesDelete),
				DiskEncryptionSet: &armcompute.DiskEncryptionSetParameters{
					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"),
				},
				DiskID:                  to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
				Lun:                     to.Ptr[int32](1),
				WriteAcceleratorEnabled: to.Ptr(true),
			},
			{
				Caching:      to.Ptr(armcompute.CachingTypesReadWrite),
				DeleteOption: to.Ptr(armcompute.DiskDeleteOptionTypesDetach),
				DiskEncryptionSet: &armcompute.DiskEncryptionSetParameters{
					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"),
				},
				DiskID:                  to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e"),
				Lun:                     to.Ptr[int32](2),
				WriteAcceleratorEnabled: to.Ptr(false),
			}},
		DataDisksToDetach: []*armcompute.DataDisksToDetach{
			{
				DetachOption: to.Ptr(armcompute.DiskDetachOptionTypesForceDetach),
				DiskID:       to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x"),
			},
			{
				DetachOption: to.Ptr(armcompute.DiskDetachOptionTypesForceDetach),
				DiskID:       to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_4_disk4_4d4e784bdafa49baa780eb2d256ff41z"),
			}},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.StorageProfile = armcompute.StorageProfile{
	// 	DataDisks: []*armcompute.DataDisk{
	// 		{
	// 			Name: to.Ptr("vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 			Caching: to.Ptr(armcompute.CachingTypesReadOnly),
	// 			CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesAttach),
	// 			DeleteOption: to.Ptr(armcompute.DiskDeleteOptionTypesDelete),
	// 			DiskSizeGB: to.Ptr[int32](30),
	// 			Lun: to.Ptr[int32](1),
	// 			ManagedDisk: &armcompute.ManagedDiskParameters{
	// 				ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 				DiskEncryptionSet: &armcompute.DiskEncryptionSetParameters{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"),
	// 				},
	// 				StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 			},
	// 			WriteAcceleratorEnabled: to.Ptr(true),
	// 		},
	// 		{
	// 			Name: to.Ptr("vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e"),
	// 			Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 			CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesAttach),
	// 			DeleteOption: to.Ptr(armcompute.DiskDeleteOptionTypesDetach),
	// 			DiskSizeGB: to.Ptr[int32](100),
	// 			Lun: to.Ptr[int32](2),
	// 			ManagedDisk: &armcompute.ManagedDiskParameters{
	// 				ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e"),
	// 				DiskEncryptionSet: &armcompute.DiskEncryptionSetParameters{
	// 					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"),
	// 				},
	// 				StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 			},
	// 			WriteAcceleratorEnabled: to.Ptr(false),
	// 	}},
	// 	ImageReference: &armcompute.ImageReference{
	// 		Offer: to.Ptr("WindowsServer"),
	// 		Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 		SKU: to.Ptr("2016-Datacenter"),
	// 		Version: to.Ptr("latest"),
	// 	},
	// 	OSDisk: &armcompute.OSDisk{
	// 		Name: to.Ptr("myOsDisk"),
	// 		Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 		CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 		DiskSizeGB: to.Ptr[int32](30),
	// 		ManagedDisk: &armcompute.ManagedDiskParameters{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"),
	// 			StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 		},
	// 		OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 	},
	// }
}

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

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Attach and detach data disks to/from the virtual machine.
 *
 * @summary Attach and detach data disks to/from the virtual machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.json
 */
async function virtualMachineAttachDetachDataDisksMaximumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const vmName = "aaaaaaaaaaaaaaaaaaaa";
  const parameters = {
    dataDisksToAttach: [
      {
        caching: "ReadOnly",
        deleteOption: "Delete",
        diskEncryptionSet: {
          id: "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}",
        },
        diskId:
          "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
        lun: 1,
        writeAcceleratorEnabled: true,
      },
      {
        caching: "ReadWrite",
        deleteOption: "Detach",
        diskEncryptionSet: {
          id: "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}",
        },
        diskId:
          "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e",
        lun: 2,
        writeAcceleratorEnabled: false,
      },
    ],
    dataDisksToDetach: [
      {
        detachOption: "ForceDetach",
        diskId:
          "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x",
      },
      {
        detachOption: "ForceDetach",
        diskId:
          "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_4_disk4_4d4e784bdafa49baa780eb2d256ff41z",
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.beginAttachDetachDataDisksAndWait(
    resourceGroupName,
    vmName,
    parameters,
  );
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.json
// this example is just showing the usage of "VirtualMachines_AttachDetachDataDisks" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "rgcompute";
string vmName = "aaaaaaaaaaaaaaaaaaaa";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

// invoke the operation
AttachDetachDataDisksRequest attachDetachDataDisksRequest = new AttachDetachDataDisksRequest
{
    DataDisksToAttach = {new DataDisksToAttach("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d")
    {
    Lun = 1,
    Caching = CachingType.ReadOnly,
    DeleteOption = DiskDeleteOptionType.Delete,
    DiskEncryptionSetId = new ResourceIdentifier("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"),
    WriteAcceleratorEnabled = true,
    }, new DataDisksToAttach("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e")
    {
    Lun = 2,
    Caching = CachingType.ReadWrite,
    DeleteOption = DiskDeleteOptionType.Detach,
    DiskEncryptionSetId = new ResourceIdentifier("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"),
    WriteAcceleratorEnabled = false,
    }},
    DataDisksToDetach = {new DataDisksToDetach("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x")
    {
    DetachOption = DiskDetachOptionType.ForceDetach,
    }, new DataDisksToDetach("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_4_disk4_4d4e784bdafa49baa780eb2d256ff41z")
    {
    DetachOption = DiskDetachOptionType.ForceDetach,
    }},
};
ArmOperation<VirtualMachineStorageProfile> lro = await virtualMachine.AttachDetachDataDisksAsync(WaitUntil.Completed, attachDetachDataDisksRequest);
VirtualMachineStorageProfile result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

Resposta da amostra

Código de estado:

200

location: https://foo.com/operationstatus

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

Código de estado:

202

location: https://foo.com/operationstatus

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

Pedido de amostra

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/azure-vm/attachDetachDataDisks?api-version=2024-07-01

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

Java

import com.azure.resourcemanager.compute.models.AttachDetachDataDisksRequest;
import com.azure.resourcemanager.compute.models.DataDisksToAttach;
import com.azure.resourcemanager.compute.models.DataDisksToDetach;
import java.util.Arrays;

/**
 * Samples for VirtualMachines AttachDetachDataDisks.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        virtualMachineAttachDetachDataDisksMinimumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines().attachDetachDataDisks("rgcompute",
            "azure-vm",
            new AttachDetachDataDisksRequest().withDataDisksToAttach(Arrays.asList(new DataDisksToAttach().withDiskId(
                "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d")))
                .withDataDisksToDetach(Arrays.asList(new DataDisksToDetach().withDiskId(
                    "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x"))),
            com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_attach_detach_data_disks_minimum_set_gen.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.virtual_machines.begin_attach_detach_data_disks(
        resource_group_name="rgcompute",
        vm_name="azure-vm",
        parameters={
            "dataDisksToAttach": [
                {
                    "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"
                }
            ],
            "dataDisksToDetach": [
                {
                    "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x"
                }
            ],
        },
    ).result()
    print(response)


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

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

Go

package armcompute_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.json
func ExampleVirtualMachinesClient_BeginAttachDetachDataDisks_virtualMachineAttachDetachDataDisksMinimumSetGen() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVirtualMachinesClient().BeginAttachDetachDataDisks(ctx, "rgcompute", "azure-vm", armcompute.AttachDetachDataDisksRequest{
		DataDisksToAttach: []*armcompute.DataDisksToAttach{
			{
				DiskID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
			}},
		DataDisksToDetach: []*armcompute.DataDisksToDetach{
			{
				DiskID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x"),
			}},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.StorageProfile = armcompute.StorageProfile{
	// 	DataDisks: []*armcompute.DataDisk{
	// 		{
	// 			Name: to.Ptr("vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 			Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 			CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesAttach),
	// 			DiskSizeGB: to.Ptr[int32](30),
	// 			Lun: to.Ptr[int32](0),
	// 			ManagedDisk: &armcompute.ManagedDiskParameters{
	// 				ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"),
	// 				StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 			},
	// 	}},
	// 	ImageReference: &armcompute.ImageReference{
	// 		Offer: to.Ptr("WindowsServer"),
	// 		Publisher: to.Ptr("MicrosoftWindowsServer"),
	// 		SKU: to.Ptr("2016-Datacenter"),
	// 		Version: to.Ptr("latest"),
	// 	},
	// 	OSDisk: &armcompute.OSDisk{
	// 		Name: to.Ptr("myOsDisk"),
	// 		Caching: to.Ptr(armcompute.CachingTypesReadWrite),
	// 		CreateOption: to.Ptr(armcompute.DiskCreateOptionTypesFromImage),
	// 		DiskSizeGB: to.Ptr[int32](30),
	// 		ManagedDisk: &armcompute.ManagedDiskParameters{
	// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"),
	// 			StorageAccountType: to.Ptr(armcompute.StorageAccountTypesPremiumLRS),
	// 		},
	// 		OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
	// 	},
	// }
}

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

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Attach and detach data disks to/from the virtual machine.
 *
 * @summary Attach and detach data disks to/from the virtual machine.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.json
 */
async function virtualMachineAttachDetachDataDisksMinimumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
  const vmName = "azure-vm";
  const parameters = {
    dataDisksToAttach: [
      {
        diskId:
          "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
      },
    ],
    dataDisksToDetach: [
      {
        diskId:
          "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x",
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.beginAttachDetachDataDisksAndWait(
    resourceGroupName,
    vmName,
    parameters,
  );
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.json
// this example is just showing the usage of "VirtualMachines_AttachDetachDataDisks" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "rgcompute";
string vmName = "azure-vm";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

// invoke the operation
AttachDetachDataDisksRequest attachDetachDataDisksRequest = new AttachDetachDataDisksRequest
{
    DataDisksToAttach = { new DataDisksToAttach("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d") },
    DataDisksToDetach = { new DataDisksToDetach("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x") },
};
ArmOperation<VirtualMachineStorageProfile> lro = await virtualMachine.AttachDetachDataDisksAsync(WaitUntil.Completed, attachDetachDataDisksRequest);
VirtualMachineStorageProfile result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

Resposta da amostra

Código de estado:

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

Código de estado:

202

location: https://foo.com/operationstatus

Definições

Name	Description
ApiEntityReference	O identificador do recurso de origem. Pode ser um instantâneo ou um ponto de restauração de disco a partir do qual criar um disco.
ApiError	Erro de api.
ApiErrorBase	Base de erro da api.
AttachDetachDataDisksRequest	Parâmetros fornecidos para a operação anexar e desanexar discos de dados na máquina virtual.
CachingTypes	Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnlyReadWrite. O comportamento padrão é: Nenhum para armazenamento padrão. 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 efêmero do disco do sistema operacional. Os valores possíveis são: CacheDisk,ResourceDiskNvmeDisk. O comportamento padrão é: CacheDisk se um estiver configurado para o tamanho da VM, caso contrário, ResourceDisk ou NvmeDisk for usado. Consulte a documentação de tamanho de 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 verificar 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êmeras para o disco do sistema operacional usado pela máquina virtual.
DiskControllerTypes	Especifica o tipo de controlador de disco configurado para a VM. Nota: Esta 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 no tamanho da VM da versão mínima de 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 implicitamente desaloca e realoca 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ê estiver 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 de 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: Delete. Se esse valor for usado, o disco do sistema operacional será excluído quando a VM for excluída. Destacar. Se esse valor for usado, o disco do sistema operacional será retido após a VM ser excluída. O valor padrão é definido como Desanexar. Para um disco de sistema operacional efêmero, o valor padrão é definido como Delete. O usuário não pode alterar a opção de exclusão para um disco de 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 suportados: ForceDetach. detachOption: ForceDetach é aplicável apenas para discos de dados gerenciados. Se uma tentativa anterior de desanexação 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. Para forçar a desanexação de uma atualização de disco de dados toBeDetached para 'true' junto 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 de mercado ou imagens de máquina virtual. Esse elemento é necessário quando você deseja usar uma imagem de plataforma, imagem de mercado ou 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 Cofre da Chave.
KeyVaultSecretReference	Especifica o local da chave de criptografia de disco, que é um segredo do Cofre da Chave.
ManagedDiskParameters	Os parâmetros do 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 junto 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. NOTA: UltraSSD_LRS só pode ser utilizado com discos de dados, não pode ser utilizado com o OS Disk.
StorageProfile	Especifica as configurações de armazenamento para os 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 do recurso de origem. Pode ser um instantâneo ou um ponto de restauração de disco a partir do qual criar um disco.

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

ApiError

Erro de api.

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

ApiErrorBase

Base de erro da api.

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

AttachDetachDataDisksRequest

Parâmetros fornecidos para a operação anexar e desanexar discos de dados na máquina virtual.

Name	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,ReadOnlyReadWrite. O comportamento padrão é: Nenhum para armazenamento padrão. ReadOnly para armazenamento Premium.

Name	Tipo	Description
None	string
ReadOnly	string
ReadWrite	string

CloudError

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

Name	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.

Name	Tipo	Description
caching	CachingTypes	Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnlyReadWrite. O comportamento padrão é: Nenhum para armazenamento padrão. 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ê estiver 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 de marketplace, também deverá usar o elemento de plano descrito anteriormente. Vazio: Este valor é usado ao criar um disco de dados vazio. Copy: Este valor é usado para criar um disco de dados a partir de um instantâneo ou outro disco. Restauração: Este valor é usado para criar um disco de dados a partir 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: Delete. Se esse valor for usado, o disco de dados será excluído quando a VM for excluída. Destacar. Se esse valor for usado, o disco de dados será retido após a VM ser 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 suportados: ForceDetach. detachOption: ForceDetach é aplicável apenas para discos de dados gerenciados. Se uma tentativa anterior de desanexação 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. Para forçar a desanexação de uma atualização de disco de dados toBeDetached para 'true' junto com a configuração detachOption: 'ForceDetach'.
diskIOPSReadWrite	integer	Especifica as IOPS Read-Write para o disco gerenciado quando StorageAccountType é UltraSSD_LRS. Retornado somente para discos de VM do VirtualMachine ScaleSet. Pode ser atualizado somente por meio de atualizações para o VirtualMachine Scale set.
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 do VirtualMachine ScaleSet. Pode ser atualizado somente por meio de atualizações para o VirtualMachine Scale set.
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 de 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 deve 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 conectado a uma VM.
managedDisk	ManagedDiskParameters	Os parâmetros do disco gerenciado.
name	string	O nome do disco.
sourceResource	ApiEntityReference	O identificador do recurso de origem. Pode ser um instantâneo ou um ponto de restauração de disco a partir 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.

Name	Tipo	Description
caching	CachingTypes	Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnlyReadWrite. O comportamento padrão é: Nenhum para armazenamento padrão. 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: Delete. Se esse valor for usado, o disco de dados será excluído quando a VM for excluída. Destacar. Se esse valor for usado, o disco de dados será retido após a VM ser 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 conectado a uma VM. Se não for especificado, o 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.

Name	Tipo	Description
detachOption	DiskDetachOptionTypes	Opções suportadas disponíveis para Desanexar um disco de uma VM. Consulte a referência do 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.

Name	Tipo	Description
Local	string

DiffDiskPlacement

Especifica o posicionamento efêmero do disco do sistema operacional. Os valores possíveis são: CacheDisk,ResourceDiskNvmeDisk. O comportamento padrão é: CacheDisk se um estiver configurado para o tamanho da VM, caso contrário, ResourceDisk ou NvmeDisk for usado. Consulte a documentação de tamanho de 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 verificar quais tamanhos de VM expõem um disco de cache. Versão mínima da api para NvmeDisk: 2024-03-01.

Name	Tipo	Description
CacheDisk	string
NvmeDisk	string
ResourceDisk	string

DiffDiskSettings

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

Name	Tipo	Description
option	DiffDiskOptions	Especifica as configurações de disco efêmero para o disco do sistema operacional.
placement	DiffDiskPlacement	Especifica o posicionamento efêmero do disco do sistema operacional. Os valores possíveis são: CacheDisk,ResourceDiskNvmeDisk. O comportamento padrão é: CacheDisk se um estiver configurado para o tamanho da VM, caso contrário, ResourceDisk ou NvmeDisk for usado. Consulte a documentação de tamanho de 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 verificar 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: Esta 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 no tamanho da VM da versão mínima de 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 implicitamente desaloca e realoca a VM. Versão mínima da api: 2022-08-01.

Name	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ê estiver 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 de marketplace, também deverá usar o elemento de plano descrito anteriormente.

Name	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: Delete. Se esse valor for usado, o disco do sistema operacional será excluído quando a VM for excluída. Destacar. Se esse valor for usado, o disco do sistema operacional será retido após a VM ser excluída. O valor padrão é definido como Desanexar. Para um disco de sistema operacional efêmero, o valor padrão é definido como Delete. O usuário não pode alterar a opção de exclusão para um disco de sistema operacional efêmero.

Name	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 suportados: ForceDetach. detachOption: ForceDetach é aplicável apenas para discos de dados gerenciados. Se uma tentativa anterior de desanexação 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. Para forçar a desanexação de uma atualização de disco de dados toBeDetached para 'true' junto com a configuração detachOption: 'ForceDetach'.

Name	Tipo	Description
ForceDetach	string

DiskEncryptionSetParameters

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

Name	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.

Name	Tipo	Description
diskEncryptionKey	KeyVaultSecretReference	Especifica o local da chave de criptografia de disco, que é um segredo do Cofre da Chave.
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 Cofre da Chave.

ImageReference

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

Name	Tipo	Description
communityGalleryImageId	string	Especificada a id exclusiva da imagem da galeria da comunidade para implantação de vm. Isso pode ser obtido na chamada GET da galeria da galeria da comunidade.
exactVersion	string	Especifica em números decimais, a versão da imagem da plataforma ou da imagem do mercado usada para criar a máquina virtual. Este campo só de leitura difere de «versão», apenas se o valor especificado no campo «versão» for «mais recente».
id	string	ID do recurso
offer	string	Especifica a oferta da imagem da plataforma ou imagem do mercado usada para criar a máquina virtual.
publisher	string	A editora de imagens.
sharedGalleryImageId	string	Especificada a id exclusiva da imagem da galeria compartilhada para implantação de vm. Isso pode ser obtido na chamada GET da imagem compartilhada da galeria.
sku	string	A imagem SKU.
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 'mais recente'. 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 se você usar '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. Por favor, não use o campo 'versão' para a implantação da imagem da galeria, a imagem da galeria deve sempre 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.

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

KeyVaultKeyReference

Especifica o local da chave de criptografia de chave no Cofre da Chave.

Name	Tipo	Description
keyUrl	string	O URL que faz referência a uma chave de criptografia de chave no Cofre da Chave.
sourceVault	SubResource	O URL relativo do Cofre da Chave que contém a chave.

KeyVaultSecretReference

Especifica o local da chave de criptografia de disco, que é um segredo do Cofre da Chave.

Name	Tipo	Description
secretUrl	string	O URL que faz referência a um segredo em um Cofre de Chaves.
sourceVault	SubResource	O URL relativo do Cofre da Chave que contém o segredo.

ManagedDiskParameters

Os parâmetros do disco gerenciado.

Name	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. NOTA: UltraSSD_LRS só pode ser utilizado com discos de dados, não pode ser utilizado com o OS Disk.

OperatingSystemTypes

O tipo de sistema operacional.

Name	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.

Name	Tipo	Description
caching	CachingTypes	Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnlyReadWrite. O comportamento padrão é: Nenhum para armazenamento padrão. 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ê estiver 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 de 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: Delete. Se esse valor for usado, o disco do sistema operacional será excluído quando a VM for excluída. Destacar. Se esse valor for usado, o disco do sistema operacional será retido após a VM ser excluída. O valor padrão é definido como Desanexar. Para um disco de sistema operacional efêmero, o valor padrão é definido como Delete. O usuário não pode alterar a opção de exclusão para um disco de sistema operacional efêmero.
diffDiskSettings	DiffDiskSettings	Especifica as configurações de disco efêmeras 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 de 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 deve existir.
managedDisk	ManagedDiskParameters	Os parâmetros do disco gerenciado.
name	string	O nome do disco.
osType	OperatingSystemTypes	Essa propriedade permite que você especifique o tipo do sistema operacional que está incluído no disco se estiver criando uma VM a partir da imagem do usuário ou de 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 junto 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.

Name	Tipo	Description
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

StorageAccountTypes

Especifica o tipo de conta de armazenamento para o disco gerenciado. NOTA: UltraSSD_LRS só pode ser utilizado com discos de dados, não pode ser utilizado com o OS Disk.

Name	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 para os discos da máquina virtual.

Name	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: Esta 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 no tamanho da VM da versão mínima de 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 implicitamente desaloca e realoca 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 de mercado ou imagens de máquina virtual. Esse elemento é necessário quando você deseja usar uma imagem de plataforma, imagem de mercado ou 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

Name	Tipo	Description
id	string	ID do recurso

VirtualHardDisk

O disco rígido virtual.

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

VMDiskSecurityProfile

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

Name	Tipo	Description
diskEncryptionSet	DiskEncryptionSetParameters	Especifica a ID do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado usado para a Chave Gerenciada do Cliente criptografada, o Disco do SO ConfidentialVM e o blob VMGuest.
securityEncryptionType	securityEncryptionTypes	Especifica o EncryptionType do disco gerenciado. Ele é definido como DiskWithVMGuestState para criptografia do disco gerenciado junto 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.