Virtual Machines - Attach Detach Data Disks

Dienst:

Compute

API-Version:

2024-03-01

Anfügen und Trennen von Datenträgern an den virtuellen Computer

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
vmName	path	True	string	Der Name des virtuellen Computers.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Typ	Beschreibung
parameters	AttachDetachDataDisksRequest	Parameter, die für den Vorgang zum Anfügen und Trennen von Datenträgern auf dem virtuellen Computer bereitgestellt werden.

Antworten

Name	Typ	Beschreibung
200 OK	StorageProfile	OK
202 Accepted		Akzeptiert Header Location: string
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/aaaaaaaaaaaaaaaaaaaa/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",
      "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"
    }
  ]
}

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_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-03-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/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/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-03-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

Beispiel für eine Antwort

Statuscode:

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

Statuscode:

202

location: https://foo.com/operationstatus

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/azure-vm/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"
    }
  ]
}

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_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-03-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/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/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-03-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

Beispiel für eine Antwort

Statuscode:

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

Statuscode:

202

location: https://foo.com/operationstatus

Definitionen

Name	Beschreibung
ApiEntityReference	Der Quellressourcenbezeichner. Dies kann ein Momentaufnahme oder Datenträgerwiederherstellungspunkt sein, von dem aus ein Datenträger erstellt werden soll.
ApiError	API-Fehler.
ApiErrorBase	API-Fehlerbasis.
AttachDetachDataDisksRequest	Parameter, die für den Vorgang zum Anfügen und Trennen von Datenträgern auf dem virtuellen Computer bereitgestellt werden.
CachingTypes	Gibt die Cacheanforderungen an. Mögliche Werte sind: None,ReadOnly,ReadWrite. Das Standardverhalten ist: Keine für Standardspeicher. ReadOnly für Storage Premium.
CloudError	Eine Fehlerantwort des Computediensts.
DataDisk	Gibt die Parameter an, die zum Hinzufügen eines Datenträgers zu einem virtuellen Computer verwendet werden. Weitere Informationen zu Datenträgern finden Sie unter Informationen zu Datenträgern und VHDs für virtuelle Azure-Computer.
DataDisksToAttach	Die Liste der verwalteten Datenträger, die angefügt werden sollen.
DataDisksToDetach	Die Liste der verwalteten Datenträger, die getrennt werden sollen.
DiffDiskOptions	Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an.
DiffDiskPlacement	Gibt die kurzlebige Datenträgerplatzierung für den Betriebssystemdatenträger an. Mögliche Werte sind: CacheDisk,ResourceDisk,NvmeDisk. Das Standardverhalten lautet: CacheDisk, wenn eine für die VM-Größe konfiguriert ist, andernfalls Wird ResourceDisk oder NvmeDisk verwendet. Informationen dazu, welche VM-Größen einen Cachedatenträger verfügbar machen, finden Sie in der Dokumentation zur VM-Größe für Windows-VMs unter https://docs.microsoft.com/azure/virtual-machines/windows/sizes und Linux-VM unter https://docs.microsoft.com/azure/virtual-machines/linux/sizes . Api-Mindestversion für NvmeDisk: 2024-03-01.
DiffDiskSettings	Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an, der vom virtuellen Computer verwendet wird.
DiskControllerTypes	Gibt den für den virtuellen Computer konfigurierten Datenträgercontrollertyp an. Hinweis: Diese Eigenschaft wird auf den Standarddatenträgercontrollertyp festgelegt, wenn nicht angegeben wird, dass der bereitgestellte virtuelle Computer erstellt wird, wobei "hyperVGeneration" basierend auf den Funktionen des Betriebssystemdatenträgers und der VM-Größe aus der angegebenen API-Mindestversion auf V2 festgelegt wird. Sie müssen die Zuordnung des virtuellen Computers aufheben, bevor Sie den Typ des Datenträgercontrollers aktualisieren, es sei denn, Sie aktualisieren die VM-Größe in der VM-Konfiguration, wodurch die Zuordnung des virtuellen Computers implizit aufgehoben und neu zugeordnet wird. Api-Mindestversion: 2022-08-01.
DiskCreateOptionTypes	Gibt an, wie der Datenträger des virtuellen Computers erstellt werden soll. Mögliche Werte sind Anfügen: Dieser Wert wird verwendet, wenn Sie einen spezialisierten Datenträger zum Erstellen des virtuellen Computers verwenden. Fromimage: Dieser Wert wird verwendet, wenn Sie ein Image zum Erstellen des virtuellen Computers verwenden. Wenn Sie ein Plattformimage verwenden, sollten Sie auch das oben beschriebene imageReference-Element verwenden. Wenn Sie ein Marketplace-Image verwenden, sollten Sie auch das zuvor beschriebene Planelement verwenden.
DiskDeleteOptionTypes	Gibt an, ob der Betriebssystemdatenträger beim Löschen des virtuellen Computers gelöscht oder getrennt werden soll. Mögliche Werte sind: Delete. Wenn dieser Wert verwendet wird, wird der Betriebssystemdatenträger gelöscht, wenn der virtuelle Computer gelöscht wird. Trennen. Wenn dieser Wert verwendet wird, wird der Betriebssystemdatenträger nach dem Löschen des virtuellen Computers beibehalten. Der Standardwert ist auf Trennen festgelegt. Für einen kurzlebigen Betriebssystemdatenträger ist der Standardwert auf Löschen festgelegt. Der Benutzer kann die Löschoption für einen kurzlebigen Betriebssystemdatenträger nicht ändern.
DiskDetachOptionTypes	Gibt das Trennverhalten an, das beim Trennen eines Datenträgers verwendet werden soll oder der sich bereits im Trennvorgang vom virtuellen Computer befindet. Unterstützte Werte: ForceDetach. detachOption: ForceDetach gilt nur für verwaltete Datenträger. Wenn ein vorheriger Trennungsversuch des Datenträgers aufgrund eines unerwarteten Fehlers vom virtuellen Computer nicht abgeschlossen wurde und der Datenträger immer noch nicht freigegeben wird, verwenden Sie die Erzwungene Trennung als letzte Option, um den Datenträger zwangsweise von der VM zu trennen. Bei Verwendung dieses Trennverhaltens wurden möglicherweise nicht alle Schreibvorgänge geleert. Dieses Feature befindet sich noch im Vorschaumodus und wird für VirtualMachineScaleSet nicht unterstützt. So trennen Sie einen Datenträger mit Erzwingung aufBeDetached auf "true", zusammen mit der Einstellung detachOption: "ForceDetach".
DiskEncryptionSetParameters	Gibt die Ressourcen-ID des kundenseitig verwalteten Datenträgerverschlüsselungssatzes für den verwalteten Datenträger an.
DiskEncryptionSettings	Gibt die Verschlüsselungseinstellungen für den Betriebssystemdatenträger an. Api-Mindestversion: 2015-06-15.
ImageReference	Gibt Informationen zum zu verwendenden Bild an. Sie können Informationen zu Plattformimages, Marketplace-Images oder VM-Images angeben. Dieses Element ist erforderlich, wenn Sie ein Plattformimage, ein Marketplace-Image oder ein VM-Image verwenden möchten, wird aber nicht in anderen Erstellungsvorgängen verwendet.
InnerError	Details zu inneren Fehlern.
KeyVaultKeyReference	Gibt den Speicherort des Schlüsselverschlüsselungsschlüssels in Key Vault an.
KeyVaultSecretReference	Gibt den Speicherort des Datenträgerverschlüsselungsschlüssels an, der ein Key Vault Geheimnis ist.
ManagedDiskParameters	Die Parameter für verwaltete Datenträger.
OperatingSystemTypes	Der Betriebssystemtyp.
OSDisk	Gibt Informationen zum Betriebssystemdatenträger an, der vom virtuellen Computer verwendet wird. Weitere Informationen zu Datenträgern finden Sie unter Informationen zu Datenträgern und VHDs für virtuelle Azure-Computer.
securityEncryptionTypes	Gibt den EncryptionType des verwalteten Datenträgers an. Er ist auf DiskWithVMGuestState für die Verschlüsselung des verwalteten Datenträgers zusammen mit dem VMGuestState-Blob, VMGuestStateOnly für die Verschlüsselung nur des VMGuestState-Blobs und NonPersistedTPM festgelegt, wenn der Firmwarestatus nicht im VMGuestState-Blob beibehalten wird. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden.
StorageAccountTypes	Gibt den Speicherkontotyp für den verwalteten Datenträger an. HINWEIS: UltraSSD_LRS nur mit Datenträgern verwendet werden kann, kann sie nicht mit dem Betriebssystemdatenträger verwendet werden.
StorageProfile	Legt die Speichereinstellungen für die Datenträger des virtuellen Computers fest.
SubResource
VirtualHardDisk	Die virtuelle Festplatte.
VMDiskSecurityProfile	Gibt das Sicherheitsprofil für den verwalteten Datenträger an.

ApiEntityReference

Der Quellressourcenbezeichner. Dies kann ein Momentaufnahme oder Datenträgerwiederherstellungspunkt sein, von dem aus ein Datenträger erstellt werden soll.

Name	Typ	Beschreibung
id	string	Die ARM-Ressourcen-ID in Form von /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

API-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	ApiErrorBase[]	Details zu API-Fehlern
innererror	InnerError	Innerer API-Fehler
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

ApiErrorBase

API-Fehlerbasis.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

AttachDetachDataDisksRequest

Parameter, die für den Vorgang zum Anfügen und Trennen von Datenträgern auf dem virtuellen Computer bereitgestellt werden.

Name	Typ	Beschreibung
dataDisksToAttach	DataDisksToAttach[]	Die Liste der verwalteten Datenträger, die angefügt werden sollen.
dataDisksToDetach	DataDisksToDetach[]	Die Liste der verwalteten Datenträger, die getrennt werden sollen.

CachingTypes

Gibt die Cacheanforderungen an. Mögliche Werte sind: None,ReadOnly,ReadWrite. Das Standardverhalten ist: Keine für Standardspeicher. ReadOnly für Storage Premium.

Name	Typ	Beschreibung
None	string
ReadOnly	string
ReadWrite	string

CloudError

Eine Fehlerantwort des Computediensts.

Name	Typ	Beschreibung
error	ApiError	API-Fehler.

DataDisk

Gibt die Parameter an, die zum Hinzufügen eines Datenträgers zu einem virtuellen Computer verwendet werden. Weitere Informationen zu Datenträgern finden Sie unter Informationen zu Datenträgern und VHDs für virtuelle Azure-Computer.

Name	Typ	Beschreibung
caching	CachingTypes	Gibt die Cacheanforderungen an. Mögliche Werte sind: None,ReadOnly,ReadWrite. Das Standardverhalten ist: Keine für Standardspeicher. ReadOnly für Storage Premium.
createOption	DiskCreateOptionTypes	Gibt an, wie der Datenträger des virtuellen Computers erstellt werden soll. Mögliche Werte sind Anfügen: Dieser Wert wird verwendet, wenn Sie einen spezialisierten Datenträger zum Erstellen des virtuellen Computers verwenden. Fromimage: Dieser Wert wird verwendet, wenn Sie ein Image zum Erstellen des Datenträgers des virtuellen Computers verwenden. Wenn Sie ein Plattformimage verwenden, sollten Sie auch das oben beschriebene imageReference-Element verwenden. Wenn Sie ein Marketplace-Image verwenden, sollten Sie auch das zuvor beschriebene Planelement verwenden. Leer: Dieser Wert wird beim Erstellen eines leeren Datenträgers verwendet. Kopieren: Dieser Wert wird verwendet, um einen Datenträger aus einem Momentaufnahme oder einem anderen Datenträger zu erstellen. Wiederherstellen: Dieser Wert wird verwendet, um einen Datenträger aus einem Datenträgerwiederherstellungspunkt zu erstellen.
deleteOption	DiskDeleteOptionTypes	Gibt an, ob der Datenträger beim Löschen des virtuellen Computers gelöscht oder getrennt werden soll. Mögliche Werte sind: Delete. Wenn dieser Wert verwendet wird, wird der Datenträger gelöscht, wenn der virtuelle Computer gelöscht wird. Trennen. Wenn dieser Wert verwendet wird, wird der Datenträger nach dem Löschen des virtuellen Computers beibehalten. Der Standardwert ist auf Trennen festgelegt.
detachOption	DiskDetachOptionTypes	Gibt das Trennverhalten an, das beim Trennen eines Datenträgers verwendet werden soll oder der sich bereits im Trennvorgang vom virtuellen Computer befindet. Unterstützte Werte: ForceDetach. detachOption: ForceDetach gilt nur für verwaltete Datenträger. Wenn ein vorheriger Trennungsversuch des Datenträgers aufgrund eines unerwarteten Fehlers vom virtuellen Computer nicht abgeschlossen wurde und der Datenträger immer noch nicht freigegeben wird, verwenden Sie die Erzwungene Trennung als letzte Option, um den Datenträger zwangsweise von der VM zu trennen. Bei Verwendung dieses Trennverhaltens wurden möglicherweise nicht alle Schreibvorgänge geleert. Dieses Feature befindet sich noch im Vorschaumodus und wird für VirtualMachineScaleSet nicht unterstützt. So trennen Sie einen Datenträger mit Erzwingung aufBeDetached auf "true", zusammen mit der Einstellung detachOption: "ForceDetach".
diskIOPSReadWrite	integer	Gibt die Read-Write IOPS für den verwalteten Datenträger an, wenn StorageAccountType UltraSSD_LRS ist. Wird nur für VirtualMachine ScaleSet-VM-Datenträger zurückgegeben. Kann nur über Updates der VirtualMachine-Skalierungsgruppe aktualisiert werden.
diskMBpsReadWrite	integer	Gibt die Bandbreite in MB pro Sekunde für den verwalteten Datenträger an, wenn StorageAccountType UltraSSD_LRS ist. Wird nur für VirtualMachine ScaleSet-VM-Datenträger zurückgegeben. Kann nur über Updates der VirtualMachine-Skalierungsgruppe aktualisiert werden.
diskSizeGB	integer	Gibt die Größe eines leeren Datenträgers in Gigabyte an. Dieses Element kann verwendet werden, um die Größe des Datenträgers in einem VM-Image zu überschreiben. Die Eigenschaft "diskSizeGB" ist die Anzahl der Bytes x 1024^3 für den Datenträger, und der Wert darf nicht größer als 1023 sein.
image	VirtualHardDisk	Die virtuelle Festplatte des Quellbenutzerimages. Die virtuelle Festplatte wird kopiert, bevor sie an den virtuellen Computer angefügt wird. Wenn SourceImage bereitgestellt wird, darf die virtuelle Zielfestplatte nicht vorhanden sein.
lun	integer	Gibt die Nummer der logischen Einheit des Datenträgers an. Dieser Wert wird verwendet, um Datenträger innerhalb des virtuellen Computers zu identifizieren und muss daher für jeden Datenträger, der an einen virtuellen Computer angefügt ist, eindeutig sein.
managedDisk	ManagedDiskParameters	Die Parameter für verwaltete Datenträger.
name	string	Der Name des Datenträgers
sourceResource	ApiEntityReference	Der Quellressourcenbezeichner. Dies kann ein Momentaufnahme oder Datenträgerwiederherstellungspunkt sein, von dem aus ein Datenträger erstellt werden soll.
toBeDetached	boolean	Gibt an, ob der Datenträger vom VirtualMachine/VirtualMachineScaleset getrennt wird.
vhd	VirtualHardDisk	Die virtuelle Festplatte.
writeAcceleratorEnabled	boolean	Gibt an, ob writeAccelerator auf dem Datenträger aktiviert oder deaktiviert werden soll.

DataDisksToAttach

Die Liste der verwalteten Datenträger, die angefügt werden sollen.

Name	Typ	Beschreibung
caching	CachingTypes	Gibt die Cacheanforderungen an. Mögliche Werte sind: None,ReadOnly,ReadWrite. Das Standardverhalten ist: Keine für Standardspeicher. ReadOnly für Storage Premium.
deleteOption	DiskDeleteOptionTypes	Gibt an, ob der Datenträger beim Löschen des virtuellen Computers gelöscht oder getrennt werden soll. Mögliche Werte sind: Delete. Wenn dieser Wert verwendet wird, wird der Datenträger gelöscht, wenn der virtuelle Computer gelöscht wird. Trennen. Wenn dieser Wert verwendet wird, wird der Datenträger nach dem Löschen des virtuellen Computers beibehalten. Der Standardwert ist auf Trennen festgelegt.
diskEncryptionSet	DiskEncryptionSetParameters	Gibt die Ressourcen-ID des kundenseitig verwalteten Datenträgerverschlüsselungssatzes für den verwalteten Datenträger an.
diskId	string	ID des verwalteten Datenträgers.
lun	integer	Die Nummer der logischen Einheit des Datenträgers. Dieser Wert wird verwendet, um Datenträger innerhalb des virtuellen Computers zu identifizieren und muss daher für jeden Datenträger, der an einen virtuellen Computer angefügt ist, eindeutig sein. Wenn nicht angegeben, wird lun automatisch zugewiesen.
writeAcceleratorEnabled	boolean	Gibt an, ob writeAccelerator auf dem Datenträger aktiviert oder deaktiviert werden soll.

DataDisksToDetach

Die Liste der verwalteten Datenträger, die getrennt werden sollen.

Name	Typ	Beschreibung
detachOption	DiskDetachOptionTypes	Unterstützte Optionen zum Trennen eines Datenträgers von einem virtuellen Computer. Weitere Informationen finden Sie unter DetachOption-Objektreferenz.
diskId	string	ID des verwalteten Datenträgers.

DiffDiskOptions

Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an.

Name	Typ	Beschreibung
Local	string

DiffDiskPlacement

Gibt die kurzlebige Datenträgerplatzierung für den Betriebssystemdatenträger an. Mögliche Werte sind: CacheDisk,ResourceDisk,NvmeDisk. Das Standardverhalten lautet: CacheDisk, wenn eine für die VM-Größe konfiguriert ist, andernfalls Wird ResourceDisk oder NvmeDisk verwendet. Informationen dazu, welche VM-Größen einen Cachedatenträger verfügbar machen, finden Sie in der Dokumentation zur VM-Größe für Windows-VMs unter https://docs.microsoft.com/azure/virtual-machines/windows/sizes und Linux-VM unter https://docs.microsoft.com/azure/virtual-machines/linux/sizes . Api-Mindestversion für NvmeDisk: 2024-03-01.

Name	Typ	Beschreibung
CacheDisk	string
NvmeDisk	string
ResourceDisk	string

DiffDiskSettings

Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an, der vom virtuellen Computer verwendet wird.

Name	Typ	Beschreibung
option	DiffDiskOptions	Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an.
placement	DiffDiskPlacement	Gibt die kurzlebige Datenträgerplatzierung für den Betriebssystemdatenträger an. Mögliche Werte sind: CacheDisk,ResourceDisk,NvmeDisk. Das Standardverhalten lautet: CacheDisk, wenn eine für die VM-Größe konfiguriert ist, andernfalls Wird ResourceDisk oder NvmeDisk verwendet. Informationen dazu, welche VM-Größen einen Cachedatenträger verfügbar machen, finden Sie in der Dokumentation zur VM-Größe für Windows-VMs unter https://docs.microsoft.com/azure/virtual-machines/windows/sizes und Linux-VM unter https://docs.microsoft.com/azure/virtual-machines/linux/sizes . Api-Mindestversion für NvmeDisk: 2024-03-01.

DiskControllerTypes

Gibt den für den virtuellen Computer konfigurierten Datenträgercontrollertyp an. Hinweis: Diese Eigenschaft wird auf den Standarddatenträgercontrollertyp festgelegt, wenn nicht angegeben wird, dass der bereitgestellte virtuelle Computer erstellt wird, wobei "hyperVGeneration" basierend auf den Funktionen des Betriebssystemdatenträgers und der VM-Größe aus der angegebenen API-Mindestversion auf V2 festgelegt wird. Sie müssen die Zuordnung des virtuellen Computers aufheben, bevor Sie den Typ des Datenträgercontrollers aktualisieren, es sei denn, Sie aktualisieren die VM-Größe in der VM-Konfiguration, wodurch die Zuordnung des virtuellen Computers implizit aufgehoben und neu zugeordnet wird. Api-Mindestversion: 2022-08-01.

Name	Typ	Beschreibung
NVMe	string
SCSI	string

DiskCreateOptionTypes

Gibt an, wie der Datenträger des virtuellen Computers erstellt werden soll. Mögliche Werte sind Anfügen: Dieser Wert wird verwendet, wenn Sie einen spezialisierten Datenträger zum Erstellen des virtuellen Computers verwenden. Fromimage: Dieser Wert wird verwendet, wenn Sie ein Image zum Erstellen des virtuellen Computers verwenden. Wenn Sie ein Plattformimage verwenden, sollten Sie auch das oben beschriebene imageReference-Element verwenden. Wenn Sie ein Marketplace-Image verwenden, sollten Sie auch das zuvor beschriebene Planelement verwenden.

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

DiskDeleteOptionTypes

Gibt an, ob der Betriebssystemdatenträger beim Löschen des virtuellen Computers gelöscht oder getrennt werden soll. Mögliche Werte sind: Delete. Wenn dieser Wert verwendet wird, wird der Betriebssystemdatenträger gelöscht, wenn der virtuelle Computer gelöscht wird. Trennen. Wenn dieser Wert verwendet wird, wird der Betriebssystemdatenträger nach dem Löschen des virtuellen Computers beibehalten. Der Standardwert ist auf Trennen festgelegt. Für einen kurzlebigen Betriebssystemdatenträger ist der Standardwert auf Löschen festgelegt. Der Benutzer kann die Löschoption für einen kurzlebigen Betriebssystemdatenträger nicht ändern.

Name	Typ	Beschreibung
Delete	string
Detach	string

DiskDetachOptionTypes

Gibt das Trennverhalten an, das beim Trennen eines Datenträgers verwendet werden soll oder der sich bereits im Trennvorgang vom virtuellen Computer befindet. Unterstützte Werte: ForceDetach. detachOption: ForceDetach gilt nur für verwaltete Datenträger. Wenn ein vorheriger Trennungsversuch des Datenträgers aufgrund eines unerwarteten Fehlers vom virtuellen Computer nicht abgeschlossen wurde und der Datenträger immer noch nicht freigegeben wird, verwenden Sie die Erzwungene Trennung als letzte Option, um den Datenträger zwangsweise von der VM zu trennen. Bei Verwendung dieses Trennverhaltens wurden möglicherweise nicht alle Schreibvorgänge geleert. Dieses Feature befindet sich noch im Vorschaumodus und wird für VirtualMachineScaleSet nicht unterstützt. So trennen Sie einen Datenträger mit Erzwingung aufBeDetached auf "true", zusammen mit der Einstellung detachOption: "ForceDetach".

Name	Typ	Beschreibung
ForceDetach	string

DiskEncryptionSetParameters

Gibt die Ressourcen-ID des kundenseitig verwalteten Datenträgerverschlüsselungssatzes für den verwalteten Datenträger an.

Name	Typ	Beschreibung
id	string	Ressourcen-ID

DiskEncryptionSettings

Gibt die Verschlüsselungseinstellungen für den Betriebssystemdatenträger an. Api-Mindestversion: 2015-06-15.

Name	Typ	Beschreibung
diskEncryptionKey	KeyVaultSecretReference	Gibt den Speicherort des Datenträgerverschlüsselungsschlüssels an, der ein Key Vault Geheimnis ist.
enabled	boolean	Gibt an, ob die Datenträgerverschlüsselung auf dem virtuellen Computer aktiviert werden soll.
keyEncryptionKey	KeyVaultKeyReference	Gibt den Speicherort des Schlüsselverschlüsselungsschlüssels in Key Vault an.

ImageReference

Gibt Informationen zum zu verwendenden Bild an. Sie können Informationen zu Plattformimages, Marketplace-Images oder VM-Images angeben. Dieses Element ist erforderlich, wenn Sie ein Plattformimage, ein Marketplace-Image oder ein VM-Image verwenden möchten, wird aber nicht in anderen Erstellungsvorgängen verwendet.

Name	Typ	Beschreibung
communityGalleryImageId	string	Geben Sie die eindeutige ID des Communitykatalogimages für die VM-Bereitstellung an. Dies kann vom GET-Aufruf des Communitykatalogimages abgerufen werden.
exactVersion	string	Gibt in Dezimalzahlen die Version des Plattformimages oder Marketplace-Images an, die zum Erstellen des virtuellen Computers verwendet wird. Dieses schreibgeschützte Feld unterscheidet sich von "version", nur wenn der im Feld "version" angegebene Wert "latest" lautet.
id	string	Ressourcen-ID
offer	string	Gibt das Angebot des Plattformimages oder Marketplace-Images an, das zum Erstellen des virtuellen Computers verwendet wird.
publisher	string	Der Imageherausgeber.
sharedGalleryImageId	string	Geben Sie die eindeutige ID des freigegebenen Katalogimages für die VM-Bereitstellung an. Dies kann über den GET-Aufruf des freigegebenen Katalogimages abgerufen werden.
sku	string	Die Bild-SKU.
version	string	Gibt die Version des Plattformimages oder Marketplace-Images an, das zum Erstellen des virtuellen Computers verwendet wird. Die zulässigen Formate sind Major.Minor.Build oder "latest". Haupt-, Neben- und Build sind Dezimalzahlen. Geben Sie „latest“ an, damit Sie die neueste Version eines Images verwenden können, das zum Zeitpunkt der Bereitstellung verfügbar ist. Selbst wenn Sie "latest" verwenden, wird das VM-Image nach der Bereitstellung nicht automatisch aktualisiert, auch wenn eine neue Version verfügbar ist. Verwenden Sie das Feld "version" nicht für die Bereitstellung von Katalogimages. Das Katalogimage sollte immer das Feld "id" für die Bereitstellung verwenden, um die neueste Version des Katalogimages zu verwenden. Legen Sie einfach "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}" im Feld "id" ohne Versionseingabe fest.

InnerError

Details zu inneren Fehlern.

Name	Typ	Beschreibung
errordetail	string	Die interne Fehlermeldung oder das Ausnahmeabbild.
exceptiontype	string	Der Ausnahmetyp.

KeyVaultKeyReference

Gibt den Speicherort des Schlüsselverschlüsselungsschlüssels in Key Vault an.

Name	Typ	Beschreibung
keyUrl	string	Die URL, die auf einen Schlüsselverschlüsselungsschlüssel in Key Vault verweist.
sourceVault	SubResource	Die relative URL der Key Vault, die den Schlüssel enthält.

KeyVaultSecretReference

Gibt den Speicherort des Datenträgerverschlüsselungsschlüssels an, der ein Key Vault Geheimnis ist.

Name	Typ	Beschreibung
secretUrl	string	Die URL, die auf ein Geheimnis in einem Key Vault verweist.
sourceVault	SubResource	Die relative URL der Key Vault, die das Geheimnis enthält.

ManagedDiskParameters

Die Parameter für verwaltete Datenträger.

Name	Typ	Beschreibung
diskEncryptionSet	DiskEncryptionSetParameters	Gibt die Ressourcen-ID des kundenseitig verwalteten Datenträgerverschlüsselungssatzes für den verwalteten Datenträger an.
id	string	Ressourcen-ID
securityProfile	VMDiskSecurityProfile	Gibt das Sicherheitsprofil für den verwalteten Datenträger an.
storageAccountType	StorageAccountTypes	Gibt den Speicherkontotyp für den verwalteten Datenträger an. HINWEIS: UltraSSD_LRS nur mit Datenträgern verwendet werden kann, kann sie nicht mit dem Betriebssystemdatenträger verwendet werden.

OperatingSystemTypes

Der Betriebssystemtyp.

Name	Typ	Beschreibung
Linux	string
Windows	string

OSDisk

Gibt Informationen zum Betriebssystemdatenträger an, der vom virtuellen Computer verwendet wird. Weitere Informationen zu Datenträgern finden Sie unter Informationen zu Datenträgern und VHDs für virtuelle Azure-Computer.

Name	Typ	Beschreibung
caching	CachingTypes	Gibt die Cacheanforderungen an. Mögliche Werte sind: None,ReadOnly,ReadWrite. Das Standardverhalten ist: Keine für Standardspeicher. ReadOnly für Storage Premium.
createOption	DiskCreateOptionTypes	Gibt an, wie der Datenträger des virtuellen Computers erstellt werden soll. Mögliche Werte sind Anfügen: Dieser Wert wird verwendet, wenn Sie einen spezialisierten Datenträger zum Erstellen des virtuellen Computers verwenden. Fromimage: Dieser Wert wird verwendet, wenn Sie ein Image zum Erstellen des virtuellen Computers verwenden. Wenn Sie ein Plattformimage verwenden, sollten Sie auch das oben beschriebene imageReference-Element verwenden. Wenn Sie ein Marketplace-Image verwenden, sollten Sie auch das zuvor beschriebene Planelement verwenden.
deleteOption	DiskDeleteOptionTypes	Gibt an, ob der Betriebssystemdatenträger beim Löschen des virtuellen Computers gelöscht oder getrennt werden soll. Mögliche Werte sind: Delete. Wenn dieser Wert verwendet wird, wird der Betriebssystemdatenträger gelöscht, wenn der virtuelle Computer gelöscht wird. Trennen. Wenn dieser Wert verwendet wird, wird der Betriebssystemdatenträger nach dem Löschen des virtuellen Computers beibehalten. Der Standardwert ist auf Trennen festgelegt. Für einen kurzlebigen Betriebssystemdatenträger ist der Standardwert auf Löschen festgelegt. Der Benutzer kann die Löschoption für einen kurzlebigen Betriebssystemdatenträger nicht ändern.
diffDiskSettings	DiffDiskSettings	Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an, der vom virtuellen Computer verwendet wird.
diskSizeGB	integer	Gibt die Größe eines leeren Datenträgers in Gigabyte an. Dieses Element kann verwendet werden, um die Größe des Datenträgers in einem VM-Image zu überschreiben. Die Eigenschaft "diskSizeGB" ist die Anzahl der Bytes x 1024^3 für den Datenträger, und der Wert darf nicht größer als 1023 sein.
encryptionSettings	DiskEncryptionSettings	Gibt die Verschlüsselungseinstellungen für den Betriebssystemdatenträger an. Api-Mindestversion: 2015-06-15.
image	VirtualHardDisk	Die virtuelle Festplatte des Quellbenutzerimages. Die virtuelle Festplatte wird kopiert, bevor sie an den virtuellen Computer angefügt wird. Wenn SourceImage bereitgestellt wird, darf die virtuelle Zielfestplatte nicht vorhanden sein.
managedDisk	ManagedDiskParameters	Die Parameter für verwaltete Datenträger.
name	string	Der Name des Datenträgers
osType	OperatingSystemTypes	Mit dieser Eigenschaft können Sie den Typ des Betriebssystems angeben, das auf dem Datenträger enthalten ist, wenn Sie einen virtuellen Computer aus einem Benutzerimage oder einer spezialisierten VHD erstellen. Mögliche Werte sind: Windows,Linux.
vhd	VirtualHardDisk	Die virtuelle Festplatte.
writeAcceleratorEnabled	boolean	Gibt an, ob writeAccelerator auf dem Datenträger aktiviert oder deaktiviert werden soll.

securityEncryptionTypes

Gibt den EncryptionType des verwalteten Datenträgers an. Er ist auf DiskWithVMGuestState für die Verschlüsselung des verwalteten Datenträgers zusammen mit dem VMGuestState-Blob, VMGuestStateOnly für die Verschlüsselung nur des VMGuestState-Blobs und NonPersistedTPM festgelegt, wenn der Firmwarestatus nicht im VMGuestState-Blob beibehalten wird. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden.

Name	Typ	Beschreibung
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

StorageAccountTypes

Gibt den Speicherkontotyp für den verwalteten Datenträger an. HINWEIS: UltraSSD_LRS nur mit Datenträgern verwendet werden kann, kann sie nicht mit dem Betriebssystemdatenträger verwendet werden.

Name	Typ	Beschreibung
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

StorageProfile

Legt die Speichereinstellungen für die Datenträger des virtuellen Computers fest.

Name	Typ	Beschreibung
dataDisks	DataDisk[]	Gibt die Parameter an, die zum Hinzufügen eines Datenträgers zu einem virtuellen Computer verwendet werden. Weitere Informationen zu Datenträgern finden Sie unter Informationen zu Datenträgern und VHDs für virtuelle Azure-Computer.
diskControllerType	DiskControllerTypes	Gibt den für den virtuellen Computer konfigurierten Datenträgercontrollertyp an. Hinweis: Diese Eigenschaft wird auf den Standarddatenträgercontrollertyp festgelegt, wenn nicht angegeben wird, dass der bereitgestellte virtuelle Computer erstellt wird, wobei "hyperVGeneration" basierend auf den Funktionen des Betriebssystemdatenträgers und der VM-Größe aus der angegebenen API-Mindestversion auf V2 festgelegt wird. Sie müssen die Zuordnung des virtuellen Computers aufheben, bevor Sie den Typ des Datenträgercontrollers aktualisieren, es sei denn, Sie aktualisieren die VM-Größe in der VM-Konfiguration, wodurch die Zuordnung des virtuellen Computers implizit aufgehoben und neu zugeordnet wird. Api-Mindestversion: 2022-08-01.
imageReference	ImageReference	Gibt Informationen zum zu verwendenden Bild an. Sie können Informationen zu Plattformimages, Marketplace-Images oder VM-Images angeben. Dieses Element ist erforderlich, wenn Sie ein Plattformimage, ein Marketplace-Image oder ein VM-Image verwenden möchten, wird aber nicht in anderen Erstellungsvorgängen verwendet.
osDisk	OSDisk	Gibt Informationen zum Betriebssystemdatenträger an, der vom virtuellen Computer verwendet wird. Weitere Informationen zu Datenträgern finden Sie unter Informationen zu Datenträgern und VHDs für virtuelle Azure-Computer.

SubResource

Name	Typ	Beschreibung
id	string	Ressourcen-ID

VirtualHardDisk

Die virtuelle Festplatte.

Name	Typ	Beschreibung
uri	string	Gibt den URI der virtuellen Festplatte an.

VMDiskSecurityProfile

Gibt das Sicherheitsprofil für den verwalteten Datenträger an.

Name	Typ	Beschreibung
diskEncryptionSet	DiskEncryptionSetParameters	Gibt die Ressourcen-ID des kundenseitig verwalteten Datenträgerverschlüsselungssatzes für den verwalteten Datenträger an, der für vom Kunden verwaltete Schlüssel verschlüsselte ConfidentialVM-Betriebssystemdatenträger und VMGuest-Blobs verwendet wird.
securityEncryptionType	securityEncryptionTypes	Gibt den EncryptionType des verwalteten Datenträgers an. Er ist auf DiskWithVMGuestState für die Verschlüsselung des verwalteten Datenträgers zusammen mit dem VMGuestState-Blob, VMGuestStateOnly für die Verschlüsselung nur des VMGuestState-Blobs und NonPersistedTPM festgelegt, wenn der Firmwarestatus nicht im VMGuestState-Blob beibehalten wird. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden.