Virtual Machines - Attach Detach Data Disks

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

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

Parâmetros do URI

Name Em Obrigatório Tipo Descrição
resourceGroupName
path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

minLength: 1

O ID da assinatura de destino.

vmName
path True

string

O nome da máquina virtual.

api-version
query True

string

minLength: 1

A versão da API a utilizar para esta operação.

Corpo do Pedido

Name Tipo Descrição
dataDisksToAttach

DataDisksToAttach[]

A lista de discos de dados gerenciados a serem anexados.

dataDisksToDetach

DataDisksToDetach[]

A lista de discos de dados gerenciados a serem desanexados.

Respostas

Name Tipo Descrição
200 OK

StorageProfile

Operação do Azure concluída com sucesso.

202 Accepted

Operação de recurso aceita.

Cabeçalhos

  • Location: string
  • Retry-After: integer
Other Status Codes

CloudError

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name Descrição
user_impersonation assumir a identidade da sua conta de utilizador

Exemplos

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen
VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

Pedido de amostra

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

Resposta da amostra

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
    }
  ]
}
location: https://foo.com/operationstatus

VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

Pedido de amostra

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

Resposta da amostra

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
    }
  ]
}
location: https://foo.com/operationstatus

Definições

Name Descrição
AdditionalDiskProperties

Especifica propriedades adicionais para um disco gerido que podem ser definidas no momento da criação implícita do disco.

ApiEntityReference

A referência da entidade da API.

ApiError

Erro de api.

ApiErrorBase

Base de erro da api.

AttachDetachDataDisksRequest

Especifica a entrada para anexar e desanexar uma lista de discos de dados gerenciados.

AvailabilityPolicyDiskDelay

Determina como lidar com discos com I/O lento.

CachingTypes

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

CloudError

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

DataDisk

Descreve um disco de dados.

DataDisksToAttach

Descreve o disco de dados a ser anexado.

DataDisksToDetach

Descreve o disco de dados a ser desanexado.

DiffDiskOptions

Especifica a opção de disco efêmero para o disco do sistema operacional.

DiffDiskPlacement

Especifica o posicionamento efêmero do disco do sistema operacional. Esta propriedade pode ser usada pelo usuário na solicitação para escolher o local, ou seja, disco de cache, disco de recurso ou espaço em disco nvme para provisionamento de disco do sistema operacional efêmero. Para obter mais informações sobre os requisitos de tamanho de disco do sistema operacional efêmero, consulte Requisitos de tamanho de disco do sistema operacional efêmero para VM do Windows no https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e VM do Linux no https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Versão mínima da api para NvmeDisk: 2024-03-01.

DiffDiskSettings

Descreve os parâmetros das configurações de disco efêmero que podem ser especificadas para o disco do sistema operacional. Nota: As configurações de disco efêmero só podem ser especificadas para o disco gerenciado.

DiskApiVersion

Especifica a versão da API de Disco usada ao aplicar Propriedades de Disco adicionais a discos geridos. O valor deve estar no formato YYY-MM-DD.

DiskAvailabilityPolicy

No caso de um problema de disponibilidade ou conectividade com o disco, especifique o comportamento da sua VM.

DiskControllerTypes

Especifica o tipo de controlador de disco configurado para a VM e VirtualMachineScaleSet. Esta propriedade só é suportada para máquinas virtuais cujo disco do sistema operativo e sku de VM suporta a Geração 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), verifique a capacidade HyperVGenerations retornada como parte das capacidades de sku de VM na resposta da API de SKUs Microsoft.Compute para a região contém V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). Para obter mais informações sobre os tipos de controlador de disco suportados, consulte https://aka.ms/azure-diskcontrollertypes.

DiskCreateOptionTypes

Especifica como o disco da máquina virtual deve ser criado. Os valores possíveis são Anexar: Esse valor é usado quando você estiver usando um disco especializado para criar a máquina virtual. FromImage: Esse valor é usado quando você está usando uma imagem para criar a máquina virtual. Se você estiver usando uma imagem de plataforma, também deverá usar o elemento imageReference descrito acima. Se você estiver usando uma imagem de marketplace, também deverá usar o elemento de plano descrito anteriormente. Vazio: Este valor é usado ao criar um disco de dados vazio. Copy: Este valor é usado para criar um disco de dados a partir de um instantâneo ou outro disco. Restauração: Este valor é usado para criar um disco de dados a partir de um ponto de restauração de disco.

DiskDeleteOptionTypes

Especifica o comportamento do disco gerenciado quando a VM é excluída, por exemplo, se o disco gerenciado é excluído ou desanexado. Os valores suportados são: Delete. Se esse valor for usado, o disco gerenciado será excluído quando a VM for excluída. Destacar. Se esse valor for usado, o disco gerenciado será retido depois que a VM for excluída. Versão mínima da api: 2021-03-01.

DiskDetachOptionTypes

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

DiskEncryptionSetParameters

Descreve o parâmetro de id de recurso do conjunto de criptografia de disco gerenciado pelo cliente que pode ser especificado para o disco. Nota: O ID do recurso do conjunto de criptografia de disco só pode ser especificado para o disco gerenciado. Consulte https://aka.ms/mdssewithcmkoverview para obter mais detalhes.

DiskEncryptionSettings

Descreve uma configuração de criptografia para um disco

ImageReference

Especifica informações sobre a imagem a ser usada. Você pode especificar informações sobre imagens de plataforma, imagens de mercado ou imagens de máquina virtual. Esse elemento é necessário quando você deseja usar uma imagem de plataforma, imagem de mercado ou imagem de máquina virtual, mas não é usado em outras operações de criação. NOTA: O editor e a oferta de referência de imagem só podem ser definidos quando cria o conjunto de escalas.

InnerError

Detalhes do erro interno.

KeyVaultKeyReference

Descreve uma referência à chave do cofre da chave

KeyVaultSecretReference

Descreve uma referência ao segredo do Key Vault

ManagedDiskParameters

Os parâmetros de um disco gerenciado.

ManagedDiskProperties

Especifica as propriedades de um disco gerido que podem ser definidas no momento da criação implícita do disco.

NetworkAccessPolicy

Política para aceder ao disco através da rede.

OperatingSystemTypes

Essa propriedade permite que você especifique o tipo do sistema operacional que está incluído no disco se estiver criando uma VM a partir de uma imagem personalizada. Os valores possíveis são: Windows,Linux.

OSDisk

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

SecurityEncryptionTypes

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

StorageAccountTypes

Especifica o tipo de conta de armazenamento para o disco gerenciado. O tipo de conta de armazenamento em disco do sistema operacional gerenciado só pode ser definido quando você cria o conjunto de escala. NOTA: UltraSSD_LRS só pode ser utilizado com discos de dados. Ele não pode ser usado com o OS Disk. Standard_LRS usa HDD padrão. StandardSSD_LRS usa SSD padrão. Premium_LRS usa SSD Premium. UltraSSD_LRS usa o disco Ultra. Premium_ZRS usa armazenamento redundante de zona SSD Premium. StandardSSD_ZRS usa armazenamento redundante de zona SSD padrão. Para obter mais informações sobre discos suportados para Máquinas Virtuais do Windows, consulte https://docs.microsoft.com/azure/virtual-machines/windows/disks-types e, para Máquinas Virtuais Linux, consulte https://docs.microsoft.com/azure/virtual-machines/linux/disks-types

StorageFaultDomainAlignmentType

Especifica o tipo de alinhamento do domínio de falha de armazenamento para o disco.

StorageProfile

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

SubResource
VirtualHardDisk

Descreve o uri de um disco.

VMDiskSecurityProfile

Especifica as configurações de perfil de segurança para o disco gerenciado. Nota: Ele só pode ser definido para VMs confidenciais.

AdditionalDiskProperties

Especifica propriedades adicionais para um disco gerido que podem ser definidas no momento da criação implícita do disco.

Name Tipo Descrição
managedDiskProperties

ManagedDiskProperties

Especifica as propriedades geridas do disco que podem ser definidas no momento da criação implícita do disco.

ApiEntityReference

A referência da entidade da API.

Name Tipo Descrição
id

string

A ID do recurso ARM na forma de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Erro de api.

Name Tipo Descrição
code

string

O código de erro.

details

ApiErrorBase[]

Os detalhes do erro Api

innererror

InnerError

O erro interno da Api

message

string

A mensagem de erro.

target

string

O alvo do erro específico.

ApiErrorBase

Base de erro da api.

Name Tipo Descrição
code

string

O código de erro.

message

string

A mensagem de erro.

target

string

O alvo do erro específico.

AttachDetachDataDisksRequest

Especifica a entrada para anexar e desanexar uma lista de discos de dados gerenciados.

Name Tipo Descrição
dataDisksToAttach

DataDisksToAttach[]

A lista de discos de dados gerenciados a serem anexados.

dataDisksToDetach

DataDisksToDetach[]

A lista de discos de dados gerenciados a serem desanexados.

AvailabilityPolicyDiskDelay

Determina como lidar com discos com I/O lento.

Valor Descrição
None

Por defeito, o comportamento é sem política de disponibilidade especificada, que é o reinício da VM após I/O de disco lento.

AutomaticReattach

Em caso de falha na I/O do disco ou resposta lenta, tente desligar e depois voltar a ligar o disco.

CachingTypes

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

Valor Descrição
None
ReadOnly
ReadWrite

CloudError

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

Name Tipo Descrição
error

ApiError

Erro de api.

DataDisk

Descreve um disco de dados.

Name Tipo Descrição
caching

CachingTypes

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

createOption

DiskCreateOptionTypes

Especifica como o disco da máquina virtual deve ser criado. Os valores possíveis são Anexar: Esse valor é usado quando você estiver usando um disco especializado para criar a máquina virtual. FromImage: Esse valor é usado quando você está usando uma imagem para criar o disco de dados da máquina virtual. Se você estiver usando uma imagem de plataforma, também deverá usar o elemento imageReference descrito acima. Se você estiver usando uma imagem de marketplace, também deverá usar o elemento de plano descrito anteriormente. Vazio: Este valor é usado ao criar um disco de dados vazio. Copy: Este valor é usado para criar um disco de dados a partir de um instantâneo ou outro disco. Restauração: Este valor é usado para criar um disco de dados a partir de um ponto de restauração de disco.

deleteOption

DiskDeleteOptionTypes

Especifica se o disco de dados deve ser excluído ou desanexado após a exclusão da VM. Os valores possíveis são: Delete. Se esse valor for usado, o disco de dados será excluído quando a VM for excluída. Destacar. Se esse valor for usado, o disco de dados será retido após a VM ser excluída. O valor padrão é definido como Desanexar.

detachOption

DiskDetachOptionTypes

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

diskIOPSReadWrite

integer (int64)

Especifica as IOPS Read-Write para o disco gerenciado quando StorageAccountType é UltraSSD_LRS.

diskMBpsReadWrite

integer (int64)

Especifica a largura de banda em MB por segundo para o disco gerenciado quando StorageAccountType é UltraSSD_LRS.

diskSizeGB

integer (int32)

Especifica o tamanho de um disco de dados vazio em gigabytes. Esse elemento pode ser usado para substituir o tamanho do disco em uma imagem de máquina virtual. A propriedade 'diskSizeGB' é o número de bytes x 1024^3 para o disco e o valor não pode ser maior que 1023.

image

VirtualHardDisk

O disco rígido virtual de imagem do usuário de origem. O disco rígido virtual será copiado antes de ser anexado à máquina virtual. Se SourceImage for fornecido, o disco rígido virtual de destino não deve existir.

lun

integer (int32)

Especifica o número da unidade lógica do disco de dados. Esse valor é usado para identificar discos de dados dentro da VM e, portanto, deve ser exclusivo para cada disco de dados conectado a uma VM.

managedDisk

ManagedDiskParameters

Os parâmetros do disco gerenciado.

name

string

O nome do disco.

sourceResource

ApiEntityReference

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

storageFaultDomainAlignment

StorageFaultDomainAlignmentType

Especifica o tipo de alinhamento do domínio de falha de armazenamento para o disco.

toBeDetached

boolean

Especifica se o disco de dados está em processo de desanexação do VirtualMachine/VirtualMachineScaleset

vhd

VirtualHardDisk

O disco rígido virtual.

writeAcceleratorEnabled

boolean

Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco.

DataDisksToAttach

Descreve o disco de dados a ser anexado.

Name Tipo Descrição
caching

CachingTypes

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

deleteOption

DiskDeleteOptionTypes

Especifica se o disco de dados deve ser excluído ou desanexado após a exclusão da VM. Os valores possíveis são: Delete. Se esse valor for usado, o disco de dados será excluído quando a VM for excluída. Destacar. Se esse valor for usado, o disco de dados será retido após a VM ser excluída. O valor padrão é definido como Desanexar.

diskEncryptionSet

DiskEncryptionSetParameters

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

diskId

string

ID do disco de dados gerenciado.

lun

integer (int32)

O número da unidade lógica do disco de dados. Esse valor é usado para identificar discos de dados dentro da VM e, portanto, deve ser exclusivo para cada disco de dados conectado a uma VM. Se não for especificado, o lun será atribuído automaticamente.

writeAcceleratorEnabled

boolean

Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco.

DataDisksToDetach

Descreve o disco de dados a ser desanexado.

Name Tipo Descrição
detachOption

DiskDetachOptionTypes

Opções suportadas disponíveis para Desanexar um disco de uma VM. Consulte a referência do objeto DetachOption para obter mais detalhes.

diskId

string

ID do disco de dados gerenciado.

DiffDiskOptions

Especifica a opção de disco efêmero para o disco do sistema operacional.

Valor Descrição
Local

DiffDiskPlacement

Especifica o posicionamento efêmero do disco do sistema operacional. Esta propriedade pode ser usada pelo usuário na solicitação para escolher o local, ou seja, disco de cache, disco de recurso ou espaço em disco nvme para provisionamento de disco do sistema operacional efêmero. Para obter mais informações sobre os requisitos de tamanho de disco do sistema operacional efêmero, consulte Requisitos de tamanho de disco do sistema operacional efêmero para VM do Windows no https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e VM do Linux no https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Versão mínima da api para NvmeDisk: 2024-03-01.

Valor Descrição
CacheDisk
ResourceDisk
NvmeDisk

DiffDiskSettings

Descreve os parâmetros das configurações de disco efêmero que podem ser especificadas para o disco do sistema operacional. Nota: As configurações de disco efêmero só podem ser especificadas para o disco gerenciado.

Name Tipo Descrição
enableFullCaching

boolean

Especifica se deve ou não ativar a cache total para esta VM, que irá armazenar o disco do sistema operativo localmente no host e tornar esta VM mais resistente a falhas de armazenamento

option

DiffDiskOptions

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

placement

DiffDiskPlacement

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

DiskApiVersion

Especifica a versão da API de Disco usada ao aplicar Propriedades de Disco adicionais a discos geridos. O valor deve estar no formato YYY-MM-DD.

Valor Descrição
2025-01-02

A versão da API Disk RP de 2025-01-02.

2026-03-02

Versão da API Disk RP de 2026-03-02.

DiskAvailabilityPolicy

No caso de um problema de disponibilidade ou conectividade com o disco, especifique o comportamento da sua VM.

Name Tipo Descrição
actionOnDiskDelay

AvailabilityPolicyDiskDelay

Determina como lidar com discos com I/O lento.

DiskControllerTypes

Especifica o tipo de controlador de disco configurado para a VM e VirtualMachineScaleSet. Esta propriedade só é suportada para máquinas virtuais cujo disco do sistema operativo e sku de VM suporta a Geração 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), verifique a capacidade HyperVGenerations retornada como parte das capacidades de sku de VM na resposta da API de SKUs Microsoft.Compute para a região contém V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). Para obter mais informações sobre os tipos de controlador de disco suportados, consulte https://aka.ms/azure-diskcontrollertypes.

Valor Descrição
SCSI
NVMe

DiskCreateOptionTypes

Especifica como o disco da máquina virtual deve ser criado. Os valores possíveis são Anexar: Esse valor é usado quando você estiver usando um disco especializado para criar a máquina virtual. FromImage: Esse valor é usado quando você está usando uma imagem para criar a máquina virtual. Se você estiver usando uma imagem de plataforma, também deverá usar o elemento imageReference descrito acima. Se você estiver usando uma imagem de marketplace, também deverá usar o elemento de plano descrito anteriormente. Vazio: Este valor é usado ao criar um disco de dados vazio. Copy: Este valor é usado para criar um disco de dados a partir de um instantâneo ou outro disco. Restauração: Este valor é usado para criar um disco de dados a partir de um ponto de restauração de disco.

Valor Descrição
FromImage
Empty
Attach
Copy
Restore

DiskDeleteOptionTypes

Especifica o comportamento do disco gerenciado quando a VM é excluída, por exemplo, se o disco gerenciado é excluído ou desanexado. Os valores suportados são: Delete. Se esse valor for usado, o disco gerenciado será excluído quando a VM for excluída. Destacar. Se esse valor for usado, o disco gerenciado será retido depois que a VM for excluída. Versão mínima da api: 2021-03-01.

Valor Descrição
Delete
Detach

DiskDetachOptionTypes

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

Valor Descrição
ForceDetach

DiskEncryptionSetParameters

Descreve o parâmetro de id de recurso do conjunto de criptografia de disco gerenciado pelo cliente que pode ser especificado para o disco. Nota: O ID do recurso do conjunto de criptografia de disco só pode ser especificado para o disco gerenciado. Consulte https://aka.ms/mdssewithcmkoverview para obter mais detalhes.

Name Tipo Descrição
id

string

ID do recurso

DiskEncryptionSettings

Descreve uma configuração de criptografia para um disco

Name Tipo Descrição
diskEncryptionKey

KeyVaultSecretReference

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

enabled

boolean

Especifica se a criptografia de disco deve ser habilitada na máquina virtual.

keyEncryptionKey

KeyVaultKeyReference

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

ImageReference

Especifica informações sobre a imagem a ser usada. Você pode especificar informações sobre imagens de plataforma, imagens de mercado ou imagens de máquina virtual. Esse elemento é necessário quando você deseja usar uma imagem de plataforma, imagem de mercado ou imagem de máquina virtual, mas não é usado em outras operações de criação. NOTA: O editor e a oferta de referência de imagem só podem ser definidos quando cria o conjunto de escalas.

Name Tipo Descrição
communityGalleryImageId

string

Especificada a id exclusiva da imagem da galeria da comunidade para implantação de vm. Isso pode ser obtido na chamada GET da galeria da galeria da comunidade.

exactVersion

string

Especifica em números decimais, a versão da imagem da plataforma ou da imagem do mercado usada para criar a máquina virtual. Este campo só de leitura difere de «versão», apenas se o valor especificado no campo «versão» for «mais recente».

id

string

ID do recurso

offer

string

Especifica a oferta da imagem da plataforma ou imagem do mercado usada para criar a máquina virtual.

publisher

string

A editora de imagens.

sharedGalleryImageId

string

Especificada a id exclusiva da imagem da galeria compartilhada para implantação de vm. Isso pode ser obtido na chamada GET da imagem compartilhada da galeria.

sku

string

A imagem SKU.

version

string

Especifica a versão da imagem da plataforma ou da imagem do marketplace usada para criar a máquina virtual. Os formatos permitidos são Major.Minor.Build ou 'mais recente'. Major, Minor e Build são números decimais. Especifique 'mais recente' para usar a versão mais recente de uma imagem disponível no momento da implantação. Mesmo se você usar 'mais recente', a imagem da VM não será atualizada automaticamente após o tempo de implantação, mesmo que uma nova versão fique disponível. Por favor, não use o campo 'versão' para a implantação da imagem da galeria, a imagem da galeria deve sempre usar o campo 'id' para implantação, para usar a versão 'mais recente' da imagem da galeria, basta definir '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' no campo 'id' sem entrada de versão.

InnerError

Detalhes do erro interno.

Name Tipo Descrição
errordetail

string

A mensagem de erro interna ou despejo de exceção.

exceptiontype

string

O tipo de exceção.

KeyVaultKeyReference

Descreve uma referência à chave do cofre da chave

Name Tipo Descrição
keyUrl

string

O URL que faz referência a uma chave de criptografia de chave no Cofre da Chave.

sourceVault

SubResource

O URL relativo do Cofre da Chave que contém a chave.

KeyVaultSecretReference

Descreve uma referência ao segredo do Key Vault

Name Tipo Descrição
secretUrl

string

O URL que faz referência a um segredo em um Cofre de Chaves.

sourceVault

SubResource

O URL relativo do Cofre da Chave que contém o segredo.

ManagedDiskParameters

Os parâmetros de um disco gerenciado.

Name Tipo Descrição
additionalDiskProperties

AdditionalDiskProperties

Especifica propriedades adicionais para o disco gerido que podem ser definidas no momento da criação implícita do disco. Esta propriedade não é capturada para os Pontos de Restauração.

diskEncryptionSet

DiskEncryptionSetParameters

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

id

string

ID do recurso

securityProfile

VMDiskSecurityProfile

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

storageAccountType

StorageAccountTypes

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

ManagedDiskProperties

Especifica as propriedades de um disco gerido que podem ser definidas no momento da criação implícita do disco.

Name Tipo Descrição
availabilityPolicy

DiskAvailabilityPolicy

No caso de um problema de disponibilidade ou conectividade com o disco, especifique o comportamento da sua VM.

burstingEnabled

boolean

Defina como true para habilitar o bursting além do destino de desempenho provisionado do disco. O bursting está desativado por padrão. Não se aplica a discos Ultra.

diskAccessId

string

ID de recurso Azure do recurso DiskAccess para utilização de endpoints privados em discos.

diskIOPSReadOnly

integer (int64)

O número total de IOPS que serão permitidas em todas as VMs que montam o disco compartilhado como Somente Leitura. Uma operação pode transferir entre 4k e 256k bytes.

diskMBpsReadOnly

integer (int64)

A taxa de transferência total (MBps) que será permitida em todas as VMs que montam o disco compartilhado como Somente leitura. MBps significa milhões de bytes por segundo - MB aqui usa a notação ISO, de potências de 10.

logicalSectorSize

integer (int32)

Tamanho lógico do setor em bytes para Ultra Disks. Os valores suportados são 512 e 4096. 4096 é o padrão.

maxShares

integer (int32)

minimum: 1

O número máximo de VMs que podem ser conectadas ao disco ao mesmo tempo. Valor maior que um indica um disco que pode ser montado em várias VMs ao mesmo tempo. Aplica-se apenas a discos de dados.

networkAccessPolicy

NetworkAccessPolicy

Política para aceder ao disco através da rede.

optimizedForFrequentAttach

boolean

Definir esta propriedade como true melhora a fiabilidade e o desempenho dos discos de dados que são frequentemente (mais de 5 vezes por dia) destacados de uma máquina virtual e ligados a outra. Essa propriedade não deve ser definida para discos que não são desanexados e anexados com freqüência, pois faz com que os discos não se alinhem com o domínio de falha da máquina virtual.

performancePlus

boolean

Defina esse sinalizador como true para obter um aumento no destino de desempenho do disco implantado. Este sinalizador só pode ser definido no tempo de criação do disco e não pode ser desativado depois de ativado.

tier

string

Nível de desempenho do disco (por exemplo, P4, S10) conforme descrito aqui: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Não se aplica a discos Ultra.

NetworkAccessPolicy

Política para aceder ao disco através da rede.

Valor Descrição
AllowAll

O disco pode ser exportado ou carregado de qualquer rede.

AllowPrivate

O disco pode ser exportado ou carregado usando os endpoints privados de um recurso DiskAccess.

DenyAll

O disco não pode ser exportado.

OperatingSystemTypes

Essa propriedade permite que você especifique o tipo do sistema operacional que está incluído no disco se estiver criando uma VM a partir de uma imagem personalizada. Os valores possíveis são: Windows,Linux.

Valor Descrição
Windows
Linux

OSDisk

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

Name Tipo Descrição
caching

CachingTypes

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

createOption

DiskCreateOptionTypes

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

deleteOption

DiskDeleteOptionTypes

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

diffDiskSettings

DiffDiskSettings

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

diskSizeGB

integer (int32)

Especifica o tamanho de um disco de dados vazio em gigabytes. Esse elemento pode ser usado para substituir o tamanho do disco em uma imagem de máquina virtual. A propriedade 'diskSizeGB' é o número de bytes x 1024^3 para o disco e o valor não pode ser maior que 1023.

encryptionSettings

DiskEncryptionSettings

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

image

VirtualHardDisk

O disco rígido virtual de imagem do usuário de origem. O disco rígido virtual será copiado antes de ser anexado à máquina virtual. Se SourceImage for fornecido, o disco rígido virtual de destino não deve existir.

managedDisk

ManagedDiskParameters

Os parâmetros do disco gerenciado.

name

string

O nome do disco.

osType

OperatingSystemTypes

Essa propriedade permite que você especifique o tipo do sistema operacional que está incluído no disco se estiver criando uma VM a partir da imagem do usuário ou de um VHD especializado. Os valores possíveis são: Windows,Linux.

storageFaultDomainAlignment

StorageFaultDomainAlignmentType

Especifica o tipo de alinhamento do domínio de falha de armazenamento para o disco.

vhd

VirtualHardDisk

O disco rígido virtual.

writeAcceleratorEnabled

boolean

Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco.

SecurityEncryptionTypes

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

Valor Descrição
VMGuestStateOnly
DiskWithVMGuestState
NonPersistedTPM

StorageAccountTypes

Especifica o tipo de conta de armazenamento para o disco gerenciado. O tipo de conta de armazenamento em disco do sistema operacional gerenciado só pode ser definido quando você cria o conjunto de escala. NOTA: UltraSSD_LRS só pode ser utilizado com discos de dados. Ele não pode ser usado com o OS Disk. Standard_LRS usa HDD padrão. StandardSSD_LRS usa SSD padrão. Premium_LRS usa SSD Premium. UltraSSD_LRS usa o disco Ultra. Premium_ZRS usa armazenamento redundante de zona SSD Premium. StandardSSD_ZRS usa armazenamento redundante de zona SSD padrão. Para obter mais informações sobre discos suportados para Máquinas Virtuais do Windows, consulte https://docs.microsoft.com/azure/virtual-machines/windows/disks-types e, para Máquinas Virtuais Linux, consulte https://docs.microsoft.com/azure/virtual-machines/linux/disks-types

Valor Descrição
Standard_LRS
Premium_LRS
StandardSSD_LRS
UltraSSD_LRS
Premium_ZRS
StandardSSD_ZRS
PremiumV2_LRS

StorageFaultDomainAlignmentType

Especifica o tipo de alinhamento do domínio de falha de armazenamento para o disco.

Valor Descrição
Aligned

Os domínios de falha de armazenamento de disco são mapeados para domínios de falha de cálculo. A implementação falha se o disco não suportar domínios de falha suficientes.

BestEffortAligned

Tente mapear domínios de falha de armazenamento para calcular domínios de falha. Os discos são desalinhados se o disco não suportar Domínios de Falha suficientes.

StorageProfile

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

Name Tipo Descrição
alignRegionalDisksToVMZone

boolean

Especifica se os discos regionais devem ser alinhados/movidos para a zona VM. Isso é aplicável apenas para VMs com propriedades de posicionamento definidas. Tenha em atenção que esta alteração é irreversível. Versão mínima da api: 2024-11-01.

dataDisks

DataDisk[]

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

diskApiVersion

DiskApiVersion

Especifica a versão da API de Disco usada ao aplicar Propriedades de Disco adicionais a discos geridos. O valor deve estar no formato YYYY-MM-DD (por exemplo, "2026-03-02").

diskControllerType

DiskControllerTypes

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

imageReference

ImageReference

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

osDisk

OSDisk

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

SubResource

Name Tipo Descrição
id

string

ID do recurso

VirtualHardDisk

Descreve o uri de um disco.

Name Tipo Descrição
uri

string

Especifica o uri do disco rígido virtual.

VMDiskSecurityProfile

Especifica as configurações de perfil de segurança para o disco gerenciado. Nota: Ele só pode ser definido para VMs confidenciais.

Name Tipo Descrição
diskEncryptionSet

DiskEncryptionSetParameters

Especifica a ID do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado usado para a Chave Gerenciada do Cliente criptografada, o Disco do SO ConfidentialVM e o blob VMGuest.

securityEncryptionType

SecurityEncryptionTypes

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