Virtual Machines - Attach Detach Data Disks

Service:: Compute

Version d'API:: 2025-11-01

Attachez et détachez des disques de données à/à partir de la machine virtuelle.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string minLength: 1	ID de l’abonnement cible.
vmName	path	True	string	Nom de la machine virtuelle.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
dataDisksToAttach	DataDisksToAttach[]	Liste des disques de données managés à joindre.
dataDisksToDetach	DataDisksToDetach[]	Liste des disques de données managés à détacher.

Réponses

Nom	Type	Description
200 OK	StorageProfile	Opération Azure terminée avec succès.
202 Accepted		Exploitation des ressources acceptée. En-têtes Location: string Retry-After: integer
Other Status Codes	CloudError	Réponse d’erreur inattendue.

Nom

Type

Description

200 OK

StorageProfile

Opération Azure terminée avec succès.

202 Accepted

Exploitation des ressources acceptée.

En-têtes

Location: string
Retry-After: integer

Other Status Codes

CloudError

Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/aaaaaaaaaaaaaaaaaaaa/attachDetachDataDisks?api-version=2025-11-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"
    }
  ]
}

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/Compute/stable/2025-11-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

Exemple de réponse

Code d’état:: 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
    }
  ]
}

Code d’état:: 202

location: https://foo.com/operationstatus

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

Exemple de requête

HTTP
dotnet

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

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/Compute/stable/2025-11-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

Exemple de réponse

Code d’état:: 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
    }
  ]
}

Code d’état:: 202

location: https://foo.com/operationstatus

Définitions

Nom	Description
ApiEntityReference	Informations de référence sur l’entité API.
ApiError	Erreur d’API.
ApiErrorBase	Base d’erreur de l’API.
AttachDetachDataDisksRequest	Spécifie l’entrée pour attacher et détacher une liste de disques de données managés.
CachingTypes	Spécifie les exigences de mise en cache. Les valeurs possibles sont : None,ReadOnly,ReadWrite. Les valeurs par défaut sont : Aucune pour le stockage Standard. ReadOnly pour le stockage Premium
CloudError	Réponse d’erreur du service de calcul.
DataDisk	Décrit un disque de données.
DataDisksToAttach	Décrit le disque de données à attacher.
DataDisksToDetach	Décrit le disque de données à détacher.
DiffDiskOptions	Spécifie l’option disque éphémère pour le disque du système d’exploitation.
DiffDiskPlacement	Spécifie le placement de disque éphémère pour le disque du système d’exploitation. Cette propriété peut être utilisée par l’utilisateur dans la demande pour choisir l’emplacement, c’est-à-dire le disque de cache, le disque de ressources ou l’espace disque nvme pour le provisionnement de disque de système d’exploitation éphémère. Pour plus d’informations sur les exigences de taille de disque de l’OS éphémère, veuillez consulter les exigences de taille de disque pour Windows VM à https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements et la VM Linux à https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Version minimale de l’API pour NvmeDisk : 2024-03-01.
DiffDiskSettings	Décrit les paramètres des paramètres de disque éphémères qui peuvent être spécifiés pour le disque du système d’exploitation. Remarque : Les paramètres de disque éphémères ne peuvent être spécifiés que pour le disque managé.
DiskControllerTypes	Spécifie le type de contrôleur de disque configuré pour la machine virtuelle et VirtualMachineScaleSet. Cette propriété n’est prise en charge que pour les machines virtuelles dont le disque et le SKU VM du système d’exploitation supportent la Génération 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), veuillez vérifier la capacité HyperVGenerations renvoyée dans le cadre des capacités du SKU VM dans la réponse de Microsoft. L’API des SKU de calcul pour la région contient V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). Pour plus d’informations sur les types de contrôleurs de disque pris en charge, consultez https://aka.ms/azure-diskcontrollertypes.
DiskCreateOptionTypes	Spécifie la façon dont le disque de machine virtuelle doit être créé. Les valeurs possibles sont Attacher : Cette valeur est utilisée lorsque vous utilisez un disque spécialisé pour créer la machine virtuelle. FromImage : Cette valeur est utilisée lorsque vous utilisez une image pour créer la machine virtuelle. Si vous utilisez une image de plateforme, vous devez également utiliser l’élément imageReference décrit ci-dessus. Si vous utilisez une image de la Place de marché, vous devez également utiliser l’élément de plan décrit précédemment. Vide : Cette valeur est utilisée lors de la création d’un disque de données vide. Copier : Cette valeur est utilisée pour créer un disque de données à partir d’un instantané ou d’un autre disque. Restauration : Cette valeur est utilisée pour créer un disque de données à partir d’un point de restauration de disque.
DiskDeleteOptionTypes	Spécifie le comportement du disque managé lorsque la machine virtuelle est supprimée, par exemple si le disque managé est supprimé ou détaché. Les valeurs prises en charge sont les suivantes : Supprimer. Si cette valeur est utilisée, le disque managé est supprimé lorsque la machine virtuelle est supprimée. Détacher. Si cette valeur est utilisée, le disque managé est conservé après la suppression de la machine virtuelle. Version minimale de l’API : 2021-03-01.
DiskDetachOptionTypes	Spécifie le comportement de détachement à utiliser lors du détachement d’un disque ou déjà en cours de détachement de la machine virtuelle. Les valeurs prises en charge sont les suivantes : ForceDetach. detachOption : ForceDetach ne s’applique qu’aux disques de données gérés. Si une tentative de détachement précédente du disque de données n’a pas été effectuée en raison d’une défaillance inattendue de la machine virtuelle et que le disque n’est toujours pas libéré, utilisez une option de détachement forcé comme option de dernier recours pour détacher le disque de force de la machine virtuelle. Toutes les écritures n’ont peut-être pas été vidées lors de l’utilisation de ce comportement de détachement. Cette fonctionnalité est encore en préversion. Pour forcer le détachement d’une mise à jour du disque de données versBeDetached à « true », ainsi que le paramètre detachOption : « ForceDetach ».
DiskEncryptionSetParameters	Décrit le paramètre de l’ID de ressource du jeu de chiffrement de disque géré par le client qui peut être spécifié pour le disque. Remarque : L’ID de ressource du jeu de chiffrement de disque ne peut être spécifié que pour le disque managé. Pour plus d’informations, consultez https://aka.ms/mdssewithcmkoverview.
DiskEncryptionSettings	Décrit les paramètres de chiffrement d’un disque
ImageReference	Spécifie des informations sur l’image à utiliser. Vous pouvez spécifier des informations sur les images de plateforme, les images de la Place de marché ou les images de machine virtuelle. Cet élément est requis lorsque vous souhaitez utiliser une image de plateforme, une image de la Place de marché ou une image de machine virtuelle, mais n’est pas utilisé dans d’autres opérations de création. REMARQUE : l’éditeur et l’offre de référence d’image ne peuvent être définis que lorsque vous créez le groupe identique.
InnerError	Détails de l’erreur interne.
KeyVaultKeyReference	Décrit une référence à Key Vault Key
KeyVaultSecretReference	Décrit une référence à Key Vault Secret
ManagedDiskParameters	Paramètres d’un disque managé.
OperatingSystemTypes	Cette propriété vous permet de spécifier le type du système d’exploitation inclus dans le disque si vous créez une machine virtuelle à partir d’une image personnalisée. Les valeurs possibles sont : Windows,Linux.
OSDisk	Spécifie des informations sur le disque du système d’exploitation utilisé par la machine virtuelle. Pour plus d’informations sur les disques, voir À propos des disques et VHD pour Azure machines virtuelles.
SecurityEncryptionTypes	Spécifie le EncryptionType du disque managé. Il est défini sur DiskWithVMGuestState pour le chiffrement du disque managé avec l’objet blob VMGuestState, VMGuestStateOnly pour le chiffrement de l’objet blob VMGuestState et nonPersistedTPM pour ne pas conserver l’état du microprogramme dans l’objet blob VMGuestState.. Remarque : Il peut être défini uniquement pour les machines virtuelles confidentielles.
StorageAccountTypes	Spécifie le type de compte de stockage pour le disque managé. Le type de compte de stockage de disque de système d’exploitation managé ne peut être défini que lorsque vous créez le groupe identique. REMARQUE : UltraSSD_LRS ne peut être utilisé qu’avec des disques de données. Il ne peut pas être utilisé avec le disque du système d’exploitation. Standard_LRS utilise hdD Standard. StandardSSD_LRS utilise ssd Standard. Premium_LRS utilise ssd Premium. UltraSSD_LRS utilise le disque Ultra. Premium_ZRS utilise le stockage redondant interzone SSD Premium. StandardSSD_ZRS utilise le stockage redondant interzone SSD Standard. Pour plus d’informations concernant les disques pris en charge pour Windows Virtual Machines, consultez https://docs.microsoft.com/azure/virtual-machines/windows/disks-types et, pour Linux Virtual Machines, consultez https://docs.microsoft.com/azure/virtual-machines/linux/disks-types
StorageFaultDomainAlignmentType	Spécifie le type d’alignement du domaine de défaut de stockage pour le disque.
StorageProfile	Spécifie les paramètres de stockage des disques de machine virtuelle.
SubResource
VirtualHardDisk	Décrit l’URI d’un disque.
VMDiskSecurityProfile	Spécifie les paramètres du profil de sécurité pour le disque managé. Remarque : Il ne peut être défini que pour les machines virtuelles confidentielles.

ApiEntityReference

Objet

Informations de référence sur l’entité API.

Nom	Type	Description
id	string	ID de ressource ARM sous la forme de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Objet

Erreur d’API.

Nom	Type	Description
code	string	Code d’erreur.
details	ApiErrorBase[]	Les détails de l’erreur Api
innererror	InnerError	L’erreur interne de l’API
message	string	Message d’erreur.
target	string	Cible de l’erreur particulière.

ApiErrorBase

Objet

Base d’erreur de l’API.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur.
target	string	Cible de l’erreur particulière.

AttachDetachDataDisksRequest

Objet

Spécifie l’entrée pour attacher et détacher une liste de disques de données managés.

Nom	Type	Description
dataDisksToAttach	DataDisksToAttach[]	Liste des disques de données managés à joindre.
dataDisksToDetach	DataDisksToDetach[]	Liste des disques de données managés à détacher.

CachingTypes

Énumération

Spécifie les exigences de mise en cache. Les valeurs possibles sont : None,ReadOnly,ReadWrite. Les valeurs par défaut sont : Aucune pour le stockage Standard. ReadOnly pour le stockage Premium

Valeur	Description
None
ReadOnly
ReadWrite

CloudError

Objet

Réponse d’erreur du service de calcul.

Nom	Type	Description
error	ApiError	Erreur d’API.

DataDisk

Objet

Décrit un disque de données.

Nom	Type	Description
caching	CachingTypes	Spécifie les exigences de mise en cache. Les valeurs possibles sont : None,ReadOnly,ReadWrite. Le comportement par défaut est : None pour le stockage Standard. ReadOnly pour le stockage Premium.
createOption	DiskCreateOptionTypes	Spécifie la façon dont le disque de machine virtuelle doit être créé. Les valeurs possibles sont Attacher : Cette valeur est utilisée lorsque vous utilisez un disque spécialisé pour créer la machine virtuelle. FromImage : Cette valeur est utilisée lorsque vous utilisez une image pour créer le disque de données de machine virtuelle. Si vous utilisez une image de plateforme, vous devez également utiliser l’élément imageReference décrit ci-dessus. Si vous utilisez une image de la Place de marché, vous devez également utiliser l’élément de plan décrit précédemment. Vide : Cette valeur est utilisée lors de la création d’un disque de données vide. Copier : Cette valeur est utilisée pour créer un disque de données à partir d’un instantané ou d’un autre disque. Restauration : Cette valeur est utilisée pour créer un disque de données à partir d’un point de restauration de disque.
deleteOption	DiskDeleteOptionTypes	Spécifie si le disque de données doit être supprimé ou détaché lors de la suppression de la machine virtuelle. Les valeurs possibles sont les suivantes : Supprimer. Si cette valeur est utilisée, le disque de données est supprimé lorsque la machine virtuelle est supprimée. Détacher. Si cette valeur est utilisée, le disque de données est conservé après la suppression de la machine virtuelle. La valeur par défaut est définie sur détacher.
detachOption	DiskDetachOptionTypes	Spécifie le comportement de détachement à utiliser lors du détachement d’un disque ou déjà en cours de détachement de la machine virtuelle. Valeurs prises en charge : ForceDetach. détacherOption : ForceDetach s’applique uniquement aux disques de données managés. Si une tentative de détachement précédente du disque de données n’a pas été effectuée en raison d’une défaillance inattendue de la machine virtuelle et que le disque n’est toujours pas libéré, utilisez une option de détachement forcé comme option de dernier recours pour détacher le disque de force de la machine virtuelle. Toutes les écritures n’ont peut-être pas été vidées lors de l’utilisation de ce comportement de détachement. Cette fonctionnalité est encore en préversion. Pour forcer le détachement d’une mise à jour du disque de données versBeDetached à « true », ainsi que le paramètre detachOption : « ForceDetach ».
diskIOPSReadWrite	integer (int64)	Spécifie les IOPS Read-Write pour le disque géré lorsque StorageAccountType est UltraSSD_LRS.
diskMBpsReadWrite	integer (int64)	Spécifie la bande passante en Mo par seconde pour le disque géré lorsque StorageAccountType est UltraSSD_LRS.
diskSizeGB	integer (int32)	Spécifie la taille d’un disque de données vide en gigaoctets. Cet élément peut être utilisé pour remplacer la taille du disque dans une image de machine virtuelle. La propriété « diskSizeGB » est le nombre d’octets x 1024^3 pour le disque et la valeur ne peut pas être supérieure à 1023.
image	VirtualHardDisk	Disque dur virtuel de l’image utilisateur source. Le disque dur virtuel est copié avant d’être attaché à la machine virtuelle. Si SourceImage est fourni, le disque dur virtuel de destination ne doit pas exister.
lun	integer (int32)	Spécifie le numéro d’unité logique du disque de données. Cette valeur est utilisée pour identifier les disques de données au sein de la machine virtuelle et doit donc être unique pour chaque disque de données attaché à une machine virtuelle.
managedDisk	ManagedDiskParameters	Paramètres de disque managé.
name	string	Nom du disque.
sourceResource	ApiEntityReference	Identificateur de ressource source. Il peut s’agir d’un instantané ou d’un point de restauration de disque à partir duquel créer un disque.
storageFaultDomainAlignment	StorageFaultDomainAlignmentType	Spécifie le type d’alignement du domaine de défaut de stockage pour le disque.
toBeDetached	boolean	Spécifie si le disque de données est en cours de détachement à partir de VirtualMachine/VirtualMachineScaleset
vhd	VirtualHardDisk	Disque dur virtuel.
writeAcceleratorEnabled	boolean	Spécifie si writeAccelerator doit être activé ou désactivé sur le disque.

DataDisksToAttach

Objet

Décrit le disque de données à attacher.

Nom	Type	Description
caching	CachingTypes	Spécifie les exigences de mise en cache. Les valeurs possibles sont : None,ReadOnly,ReadWrite. Le comportement par défaut est : None pour le stockage Standard. ReadOnly pour le stockage Premium.
deleteOption	DiskDeleteOptionTypes	Spécifie si le disque de données doit être supprimé ou détaché lors de la suppression de la machine virtuelle. Les valeurs possibles sont les suivantes : Supprimer. Si cette valeur est utilisée, le disque de données est supprimé lorsque la machine virtuelle est supprimée. Détacher. Si cette valeur est utilisée, le disque de données est conservé après la suppression de la machine virtuelle. La valeur par défaut est définie sur détacher.
diskEncryptionSet	DiskEncryptionSetParameters	Spécifie l’ID de ressource du jeu de chiffrement de disque managé du client pour le disque managé.
diskId	string	ID du disque de données managé.
lun	integer (int32)	Numéro d’unité logique du disque de données. Cette valeur est utilisée pour identifier les disques de données au sein de la machine virtuelle et doit donc être unique pour chaque disque de données attaché à une machine virtuelle. S’il n’est pas spécifié, lun est attribué automatiquement.
writeAcceleratorEnabled	boolean	Spécifie si writeAccelerator doit être activé ou désactivé sur le disque.

DataDisksToDetach

Objet

Décrit le disque de données à détacher.

Nom	Type	Description
detachOption	DiskDetachOptionTypes	Options prises en charge pour détacher un disque d’une machine virtuelle. Pour plus d’informations, reportez-vous à la référence de l’objet DetachOption.
diskId	string	ID du disque de données managé.

DiffDiskOptions

Énumération

Spécifie l’option disque éphémère pour le disque du système d’exploitation.

Valeur	Description
Local

DiffDiskPlacement

Énumération

Spécifie le placement de disque éphémère pour le disque du système d’exploitation. Cette propriété peut être utilisée par l’utilisateur dans la demande pour choisir l’emplacement, c’est-à-dire le disque de cache, le disque de ressources ou l’espace disque nvme pour le provisionnement de disque de système d’exploitation éphémère. Pour plus d’informations sur les exigences de taille de disque de l’OS éphémère, veuillez consulter les exigences de taille de disque pour Windows VM à https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements et la VM Linux à https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Version minimale de l’API pour NvmeDisk : 2024-03-01.

Valeur	Description
CacheDisk
ResourceDisk
NvmeDisk

DiffDiskSettings

Objet

Décrit les paramètres des paramètres de disque éphémères qui peuvent être spécifiés pour le disque du système d’exploitation. Remarque : Les paramètres de disque éphémères ne peuvent être spécifiés que pour le disque managé.

Nom	Type	Description
enableFullCaching	boolean	Précise s’il faut activer ou non la mise en cache complète de cette VM, ce qui mettra en cache localement le disque du système d’exploitation sur l’hôte et rendra cette VM plus résiliente face aux coupures de stockage
option	DiffDiskOptions	Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation.
placement	DiffDiskPlacement	Spécifie le placement de disque éphémère pour le disque du système d’exploitation. Les valeurs possibles sont les suivantes : CacheDisk,ResourceDisk,NvmeDisk. Le comportement par défaut est : CacheDisk si une taille de machine virtuelle est configurée pour la taille de machine virtuelle sinon ResourceDisk ou NvmeDisk est utilisé. Reportez-vous à la documentation sur la taille des machines virtuelles Windows sur https://docs.microsoft.com/azure/virtual-machines/windows/sizes et la machine virtuelle Linux à https://docs.microsoft.com/azure/virtual-machines/linux/sizes pour vérifier quelles tailles de machine virtuelle exposent un disque de cache. Version minimale de l’API pour NvmeDisk : 2024-03-01.

DiskControllerTypes

Énumération

Spécifie le type de contrôleur de disque configuré pour la machine virtuelle et VirtualMachineScaleSet. Cette propriété n’est prise en charge que pour les machines virtuelles dont le disque et le SKU VM du système d’exploitation supportent la Génération 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), veuillez vérifier la capacité HyperVGenerations renvoyée dans le cadre des capacités du SKU VM dans la réponse de Microsoft. L’API des SKU de calcul pour la région contient V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). Pour plus d’informations sur les types de contrôleurs de disque pris en charge, consultez https://aka.ms/azure-diskcontrollertypes.

Valeur	Description
SCSI
NVMe

DiskCreateOptionTypes

Énumération

Spécifie la façon dont le disque de machine virtuelle doit être créé. Les valeurs possibles sont Attacher : Cette valeur est utilisée lorsque vous utilisez un disque spécialisé pour créer la machine virtuelle. FromImage : Cette valeur est utilisée lorsque vous utilisez une image pour créer la machine virtuelle. Si vous utilisez une image de plateforme, vous devez également utiliser l’élément imageReference décrit ci-dessus. Si vous utilisez une image de la Place de marché, vous devez également utiliser l’élément de plan décrit précédemment. Vide : Cette valeur est utilisée lors de la création d’un disque de données vide. Copier : Cette valeur est utilisée pour créer un disque de données à partir d’un instantané ou d’un autre disque. Restauration : Cette valeur est utilisée pour créer un disque de données à partir d’un point de restauration de disque.

Valeur	Description
FromImage
Empty
Attach
Copy
Restore

DiskDeleteOptionTypes

Énumération

Spécifie le comportement du disque managé lorsque la machine virtuelle est supprimée, par exemple si le disque managé est supprimé ou détaché. Les valeurs prises en charge sont les suivantes : Supprimer. Si cette valeur est utilisée, le disque managé est supprimé lorsque la machine virtuelle est supprimée. Détacher. Si cette valeur est utilisée, le disque managé est conservé après la suppression de la machine virtuelle. Version minimale de l’API : 2021-03-01.

Valeur	Description
Delete
Detach

DiskDetachOptionTypes

Énumération

Spécifie le comportement de détachement à utiliser lors du détachement d’un disque ou déjà en cours de détachement de la machine virtuelle. Les valeurs prises en charge sont les suivantes : ForceDetach. detachOption : ForceDetach ne s’applique qu’aux disques de données gérés. Si une tentative de détachement précédente du disque de données n’a pas été effectuée en raison d’une défaillance inattendue de la machine virtuelle et que le disque n’est toujours pas libéré, utilisez une option de détachement forcé comme option de dernier recours pour détacher le disque de force de la machine virtuelle. Toutes les écritures n’ont peut-être pas été vidées lors de l’utilisation de ce comportement de détachement. Cette fonctionnalité est encore en préversion. Pour forcer le détachement d’une mise à jour du disque de données versBeDetached à « true », ainsi que le paramètre detachOption : « ForceDetach ».

Valeur	Description
ForceDetach

DiskEncryptionSetParameters

Objet

Décrit le paramètre de l’ID de ressource du jeu de chiffrement de disque géré par le client qui peut être spécifié pour le disque. Remarque : L’ID de ressource du jeu de chiffrement de disque ne peut être spécifié que pour le disque managé. Pour plus d’informations, consultez https://aka.ms/mdssewithcmkoverview.

Nom	Type	Description
id	string	ID de ressource

DiskEncryptionSettings

Objet

Décrit les paramètres de chiffrement d’un disque

Nom	Type	Description
diskEncryptionKey	KeyVaultSecretReference	Spécifie l’emplacement de la clé de chiffrement du disque, qui est un Key Vault Secret.
enabled	boolean	Spécifie si le chiffrement de disque doit être activé sur la machine virtuelle.
keyEncryptionKey	KeyVaultKeyReference	Précise l’emplacement de la clé de chiffrement de la clé dans Key Vault.

ImageReference

Objet

Spécifie des informations sur l’image à utiliser. Vous pouvez spécifier des informations sur les images de plateforme, les images de la Place de marché ou les images de machine virtuelle. Cet élément est requis lorsque vous souhaitez utiliser une image de plateforme, une image de la Place de marché ou une image de machine virtuelle, mais n’est pas utilisé dans d’autres opérations de création. REMARQUE : l’éditeur et l’offre de référence d’image ne peuvent être définis que lorsque vous créez le groupe identique.

Nom	Type	Description
communityGalleryImageId	string	Spécifie l’ID unique de l’image de la galerie de communautés pour le déploiement de machines virtuelles. Cette opération peut être extraite de l’appel GET de la galerie de la communauté.
exactVersion	string	Spécifie, en nombres décimaux, la version de l’image de plateforme ou de l’image de la place de marché utilisée pour créer la machine virtuelle. Ce champ en lecture seule diffère de 'version', uniquement si la valeur spécifiée dans le champ 'version' est 'latest'.
id	string	ID de ressource
offer	string	Spécifie l’offre de l’image de plateforme ou de la place de marché utilisée pour créer la machine virtuelle.
publisher	string	L’image publisher.
sharedGalleryImageId	string	Spécifie l’ID unique de l’image de galerie partagée pour le déploiement de machines virtuelles. Cette opération peut être extraite de l’appel GET de l’image de galerie partagée.
sku	string	Référence SKU d’image.
version	string	Spécifie la version de l’image de plateforme ou de la place de marché utilisée pour créer la machine virtuelle. Les formats autorisés sont Major.Minor.Build ou « latest ». Les nombres principaux, mineurs et build sont des nombres décimaux. Spécifiez « latest » pour utiliser la dernière version d’une image disponible au moment du déploiement. Même si vous utilisez la « dernière version », l’image de machine virtuelle ne sera pas automatiquement mise à jour après le déploiement même si une nouvelle version devient disponible. Merci de ne pas utiliser le champ « version » pour le déploiement d'image de galerie, l'image de galerie doit toujours utiliser le champ « id » pour le déploiement, pour utiliser la version « plus récente » de l'image de galerie, il suffit de définir « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft. Compute/galleries/{galleryName}/images/{imageName}' dans le champ 'id' sans saisie de version.

InnerError

Objet

Détails de l’erreur interne.

Nom	Type	Description
errordetail	string	Message d’erreur interne ou vidage d’exception.
exceptiontype	string	Type d'exception.

KeyVaultKeyReference

Objet

Décrit une référence à Key Vault Key

Nom	Type	Description
keyUrl	string	L’URL faisant référence à une clé de chiffrement de clé dans Key Vault.
sourceVault	SubResource	L’URL relative du Key Vault contenant la clé.

KeyVaultSecretReference

Objet

Décrit une référence à Key Vault Secret

Nom	Type	Description
secretUrl	string	L’URL faisant référence à un secret dans un Key Vault.
sourceVault	SubResource	L’URL relative du Key Vault contenant le secret.

ManagedDiskParameters

Objet

Paramètres d’un disque managé.

Nom	Type	Description
diskEncryptionSet	DiskEncryptionSetParameters	Spécifie l’ID de ressource du jeu de chiffrement de disque managé du client pour le disque managé.
id	string	ID de ressource
securityProfile	VMDiskSecurityProfile	Spécifie le profil de sécurité du disque managé.
storageAccountType	StorageAccountTypes	Spécifie le type de compte de stockage pour le disque managé. REMARQUE : UltraSSD_LRS ne peut être utilisé qu’avec des disques de données, il ne peut pas être utilisé avec le disque du système d’exploitation.

OperatingSystemTypes

Énumération

Cette propriété vous permet de spécifier le type du système d’exploitation inclus dans le disque si vous créez une machine virtuelle à partir d’une image personnalisée. Les valeurs possibles sont : Windows,Linux.

Valeur	Description
Windows
Linux

OSDisk

Objet

Spécifie des informations sur le disque du système d’exploitation utilisé par la machine virtuelle. Pour plus d’informations sur les disques, voir À propos des disques et VHD pour Azure machines virtuelles.

Nom	Type	Description
caching	CachingTypes	Spécifie les exigences de mise en cache. Les valeurs possibles sont : None,ReadOnly,ReadWrite. Le comportement par défaut est : None pour le stockage Standard. ReadOnly pour le stockage Premium.
createOption	DiskCreateOptionTypes	Spécifie la façon dont le disque de machine virtuelle doit être créé. Les valeurs possibles sont Attacher : Cette valeur est utilisée lorsque vous utilisez un disque spécialisé pour créer la machine virtuelle. FromImage : Cette valeur est utilisée lorsque vous utilisez une image pour créer la machine virtuelle. Si vous utilisez une image de plateforme, vous devez également utiliser l’élément imageReference décrit ci-dessus. Si vous utilisez une image de la Place de marché, vous devez également utiliser l’élément de plan décrit précédemment.
deleteOption	DiskDeleteOptionTypes	Spécifie si le disque du système d’exploitation doit être supprimé ou détaché lors de la suppression de la machine virtuelle. Les valeurs possibles sont les suivantes : Supprimer. Si cette valeur est utilisée, le disque du système d’exploitation est supprimé lorsque la machine virtuelle est supprimée. Détacher. Si cette valeur est utilisée, le disque du système d’exploitation est conservé après la suppression de la machine virtuelle. La valeur par défaut est définie sur détacher. Pour un disque de système d’exploitation éphémère, la valeur par défaut est définie sur Supprimer. L’utilisateur ne peut pas modifier l’option de suppression d’un disque de système d’exploitation éphémère.
diffDiskSettings	DiffDiskSettings	Spécifie les paramètres de disque éphémères pour le disque du système d’exploitation utilisé par la machine virtuelle.
diskSizeGB	integer (int32)	Spécifie la taille d’un disque de données vide en gigaoctets. Cet élément peut être utilisé pour remplacer la taille du disque dans une image de machine virtuelle. La propriété « diskSizeGB » est le nombre d’octets x 1024^3 pour le disque et la valeur ne peut pas être supérieure à 1023.
encryptionSettings	DiskEncryptionSettings	Spécifie les paramètres de chiffrement du disque du système d’exploitation. Version minimale de l’API : 2015-06-15.
image	VirtualHardDisk	Disque dur virtuel de l’image utilisateur source. Le disque dur virtuel est copié avant d’être attaché à la machine virtuelle. Si SourceImage est fourni, le disque dur virtuel de destination ne doit pas exister.
managedDisk	ManagedDiskParameters	Paramètres de disque managé.
name	string	Nom du disque.
osType	OperatingSystemTypes	Cette propriété vous permet de spécifier le type du système d’exploitation inclus dans le disque si vous créez une machine virtuelle à partir d’une image utilisateur ou d’un disque dur virtuel spécialisé. Les valeurs possibles sont : Windows,Linux.
storageFaultDomainAlignment	StorageFaultDomainAlignmentType	Spécifie le type d’alignement du domaine de défaut de stockage pour le disque.
vhd	VirtualHardDisk	Disque dur virtuel.
writeAcceleratorEnabled	boolean	Spécifie si writeAccelerator doit être activé ou désactivé sur le disque.

SecurityEncryptionTypes

Énumération

Spécifie le EncryptionType du disque managé. Il est défini sur DiskWithVMGuestState pour le chiffrement du disque managé avec l’objet blob VMGuestState, VMGuestStateOnly pour le chiffrement de l’objet blob VMGuestState et nonPersistedTPM pour ne pas conserver l’état du microprogramme dans l’objet blob VMGuestState.. Remarque : Il peut être défini uniquement pour les machines virtuelles confidentielles.

Valeur	Description
VMGuestStateOnly
DiskWithVMGuestState
NonPersistedTPM

StorageAccountTypes

Énumération

Spécifie le type de compte de stockage pour le disque managé. Le type de compte de stockage de disque de système d’exploitation managé ne peut être défini que lorsque vous créez le groupe identique. REMARQUE : UltraSSD_LRS ne peut être utilisé qu’avec des disques de données. Il ne peut pas être utilisé avec le disque du système d’exploitation. Standard_LRS utilise hdD Standard. StandardSSD_LRS utilise ssd Standard. Premium_LRS utilise ssd Premium. UltraSSD_LRS utilise le disque Ultra. Premium_ZRS utilise le stockage redondant interzone SSD Premium. StandardSSD_ZRS utilise le stockage redondant interzone SSD Standard. Pour plus d’informations concernant les disques pris en charge pour Windows Virtual Machines, consultez https://docs.microsoft.com/azure/virtual-machines/windows/disks-types et, pour Linux Virtual Machines, consultez https://docs.microsoft.com/azure/virtual-machines/linux/disks-types

Valeur	Description
Standard_LRS
Premium_LRS
StandardSSD_LRS
UltraSSD_LRS
Premium_ZRS
StandardSSD_ZRS
PremiumV2_LRS

StorageFaultDomainAlignmentType

Énumération

Spécifie le type d’alignement du domaine de défaut de stockage pour le disque.

Valeur	Description
Aligned	Les domaines de défaut de stockage disque sont mappés aux domaines de défaut de calcul. Le déploiement échoue si le disque ne prend pas en charge suffisamment de domaines de faillite.
BestEffortAligned	Tentez de mapper les domaines de défaut de stockage pour calculer les domaines de défaut. Les disques sont désalignés si le disque ne prend pas en charge suffisamment de domaines de faute.

StorageProfile

Objet

Spécifie les paramètres de stockage des disques de machine virtuelle.

Nom	Type	Description
alignRegionalDisksToVMZone	boolean	Spécifie si les disques régionaux doivent être alignés/déplacés vers la zone de machine virtuelle. Cela s’applique uniquement aux machines virtuelles dont la propriété de placement est définie. Veuillez noter que cette modification est irréversible. Version minimale de l’API : 2024-11-01.
dataDisks	DataDisk[]	Spécifie les paramètres utilisés pour ajouter un disque de données à une machine virtuelle. Pour plus d’informations sur les disques, voir À propos des disques et VHD pour Azure machines virtuelles.
diskControllerType	DiskControllerTypes	Spécifie le type de contrôleur de disque configuré pour la machine virtuelle. Remarque : Cette propriété est définie sur le type de contrôleur de disque par défaut si aucune machine virtuelle fournie n’est créée avec « hyperVGeneration » définie sur V2 en fonction des fonctionnalités du disque du système d’exploitation et de la taille de machine virtuelle à partir de la version minimale spécifiée de l’API. Vous devez libérer la machine virtuelle avant de mettre à jour son type de contrôleur de disque, sauf si vous mettez à jour la taille de machine virtuelle dans la configuration de la machine virtuelle qui désalloue et réalloue implicitement la machine virtuelle. Version minimale de l’API : 2022-08-01.
imageReference	ImageReference	Spécifie des informations sur l’image à utiliser. Vous pouvez spécifier des informations sur les images de plateforme, les images de la Place de marché ou les images de machine virtuelle. Cet élément est requis lorsque vous souhaitez utiliser une image de plateforme, une image de la Place de marché ou une image de machine virtuelle, mais n’est pas utilisé dans d’autres opérations de création.
osDisk	OSDisk	Spécifie des informations sur le disque du système d’exploitation utilisé par la machine virtuelle. Pour plus d’informations sur les disques, voir À propos des disques et VHD pour Azure machines virtuelles.

SubResource

Objet

Nom	Type	Description
id	string	ID de ressource

VirtualHardDisk

Objet

Décrit l’URI d’un disque.

Nom	Type	Description
uri	string	Spécifie l’URI du disque dur virtuel.

VMDiskSecurityProfile

Objet

Spécifie les paramètres du profil de sécurité pour le disque managé. Remarque : Il ne peut être défini que pour les machines virtuelles confidentielles.

Nom	Type	Description
diskEncryptionSet	DiskEncryptionSetParameters	Spécifie l’ID de ressource du jeu de chiffrement de disque managé du client pour le disque managé utilisé pour le disque de système d’exploitation ConfidentielVM chiffré par clé gérée par le client et l’objet blob VMGuest.
securityEncryptionType	SecurityEncryptionTypes	Spécifie le EncryptionType du disque managé. Il est défini sur DiskWithVMGuestState pour le chiffrement du disque managé avec l’objet blob VMGuestState, VMGuestStateOnly pour le chiffrement de l’objet blob VMGuestState et nonPersistedTPM pour ne pas conserver l’état du microprogramme dans l’objet blob VMGuestState.. Remarque : Il peut être défini uniquement pour les machines virtuelles confidentielles.