Compartilhar via


Virtual Machines - Attach Detach Data Disks

Anexar e desanexar 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=2025-04-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
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

A 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 ser usada para esta operação.

Corpo da solicitação

Nome Tipo Description
dataDisksToAttach

DataDisksToAttach[]

A lista de discos de dados gerenciados a serem anexados.

dataDisksToDetach

DataDisksToDetach[]

A lista de discos de dados gerenciados a serem desanexados.

Respostas

Nome Tipo Description
200 OK

StorageProfile

A operação do Azure foi concluída com êxito.

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
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen
VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen

VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen

Solicitação de exemplo

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

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

Solicitação de exemplo

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

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

Nome Description
ApiEntityReference

A referência da entidade de API.

ApiError

Erro de API.

ApiErrorBase

Base de erros da API.

AttachDetachDataDisksRequest

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

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

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 de disco efêmero para o disco do sistema operacional. Essa 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 os requisitos de tamanho de disco do sistema operacional efêmero para vm do Windows e https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements VM linux em 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. Observação: as configurações de disco efêmero só podem ser especificadas para o disco gerenciado.

DiskControllerTypes

Especifica o tipo de controlador de disco configurado para a VM e VirtualMachineScaleSet. Essa propriedade só tem suporte para máquinas virtuais cujo disco do sistema operacional e sku de VM dá suporte à Geração 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), verifique se a funcionalidade HyperVGenerations retornada como parte dos recursos de sku de VM na resposta da API de SKUs da 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 com suporte, 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ê está usando um disco especializado para criar a máquina virtual. FromImage: Esse valor é usado quando você está usando uma imagem para criar a máquina virtual. Se você estiver usando uma imagem de plataforma, também deverá usar o elemento imageReference descrito acima. Se você estiver usando uma imagem do marketplace, também deverá usar o elemento de plano descrito anteriormente. Vazio: Esse valor é usado ao criar um disco de dados vazio. Cópia: Esse valor é usado para criar um disco de dados a partir de um instantâneo ou outro disco. Restaurar: esse 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 com suporte são: Excluir. 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á mantido após a exclusão da VM. Versão mínima da API: 2021-03-01.

DiskDetachOptionTypes

Especifica o comportamento de desanexar a ser usado ao desanexar um disco ou que já está em processo de desanexação da máquina virtual. Os valores com suporte são: ForceDetach. detachOption: ForceDetach é aplicável somente a discos de dados gerenciados. Se uma tentativa de desanexação anterior do disco de dados não tiver sido concluída devido a uma falha inesperada da máquina virtual e o disco ainda não for 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 desanexar. Esse recurso ainda está em versão prévia. Para forçar a desanexação de uma atualização de disco de dados paraBeDetached como 'true' juntamente com a configuração de detachOption: 'ForceDetach'.

DiskEncryptionSetParameters

Descreve o parâmetro da ID de recurso do conjunto de criptografia de disco gerenciado pelo cliente que pode ser especificada para disco. Observação: A ID do recurso do conjunto de criptografia de disco só pode ser especificada para o disco gerenciado. Consulte https://aka.ms/mdssewithcmkoverview para obter mais detalhes.

DiskEncryptionSettings

Descreve as configurações de criptografia de um disco

ImageReference

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

InnerError

Detalhes do erro interno.

KeyVaultKeyReference

Descreve uma referência à chave do Key Vault

KeyVaultSecretReference

Descreve uma referência ao Segredo do Key Vault

ManagedDiskParameters

Os parâmetros de um disco gerenciado.

OperatingSystemTypes

Essa propriedade permite que você especifique o tipo do sistema operacional incluído no disco se criar uma VM com base na imagem do usuário ou em um VHD especializado. 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 juntamente com blob VMGuestState, VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado de firmware no blob VMGuestState.. Observação: 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 dimensionamento. OBSERVAÇÃO: UltraSSD_LRS só pode ser usado com discos de dados. Ele não pode ser usado com o disco do sistema operacional. Standard_LRS usa o HDD Standard. StandardSSD_LRS usa o SSD Standard. Premium_LRS usa o SSD Premium. UltraSSD_LRS usa disco Ultra. Premium_ZRS usa o armazenamento com redundância de zona SSD Premium. StandardSSD_ZRS usa o armazenamento com redundância de zona SSD Standard. Para obter mais informações sobre discos com suporte 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

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. Observação: Ele só pode ser definido para VMs confidenciais.

ApiEntityReference

A referência da entidade de API.

Nome Tipo Description
id

string

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

ApiError

Erro de API.

Nome Tipo Description
code

string

O código de erro.

details

ApiErrorBase[]

Os detalhes do erro da API

innererror

InnerError

O erro interno da API

message

string

A mensagem de erro.

target

string

O destino do erro específico.

ApiErrorBase

Base de erros da API.

Nome Tipo Description
code

string

O código de erro.

message

string

A mensagem de erro.

target

string

O destino do erro específico.

AttachDetachDataDisksRequest

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

Nome Tipo Description
dataDisksToAttach

DataDisksToAttach[]

A lista de discos de dados gerenciados a serem anexados.

dataDisksToDetach

DataDisksToDetach[]

A lista de discos de dados gerenciados a serem desanexados.

CachingTypes

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

Valor Description
None
ReadOnly
ReadWrite

CloudError

Uma resposta de erro do serviço Compute.

Nome Tipo Description
error

ApiError

Erro de API.

DataDisk

Descreve um disco de dados.

Nome Tipo Description
caching

CachingTypes

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

createOption

DiskCreateOptionTypes

Especifica como o disco da máquina virtual deve ser criado. Os valores possíveis são Anexar: Esse valor é usado quando você está usando um disco especializado para criar a máquina virtual. FromImage: Esse valor é usado quando você está usando uma imagem para criar o disco de dados da máquina virtual. Se você estiver usando uma imagem de plataforma, também deverá usar o elemento imageReference descrito acima. Se você estiver usando uma imagem do marketplace, também deverá usar o elemento de plano descrito anteriormente. Vazio: Esse valor é usado ao criar um disco de dados vazio. Cópia: Esse valor é usado para criar um disco de dados a partir de um instantâneo ou outro disco. Restaurar: esse 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: Excluir. 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 exclusão da VM. O valor padrão é definido como Desanexar.

detachOption

DiskDetachOptionTypes

Especifica o comportamento de desanexar a ser usado ao desanexar um disco ou que já está em processo de desanexação da máquina virtual. Valores com suporte: ForceDetach. detachOption: ForceDetach é aplicável somente para discos de dados gerenciados. Se uma tentativa de desanexação anterior do disco de dados não tiver sido concluída devido a uma falha inesperada da máquina virtual e o disco ainda não for 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 desanexar. Esse recurso ainda está em versão prévia. Para forçar a desanexação de uma atualização de disco de dados paraBeDetached como 'true' juntamente com a configuração de detachOption: 'ForceDetach'.

diskIOPSReadWrite

integer (int64)

Especifica o 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 da imagem do usuário de origem. O disco rígido virtual será copiado antes de ser anexado à máquina virtual. Se SourceImage for fornecido, o disco rígido virtual de destino não deverá existir.

lun

integer (int32)

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

managedDisk

ManagedDiskParameters

Os parâmetros de disco gerenciado.

name

string

O nome do disco.

sourceResource

ApiEntityReference

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

toBeDetached

boolean

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

vhd

VirtualHardDisk

O disco rígido virtual.

writeAcceleratorEnabled

boolean

Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco.

DataDisksToAttach

Descreve o disco de dados a ser anexado.

Nome Tipo Description
caching

CachingTypes

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

deleteOption

DiskDeleteOptionTypes

Especifica se o disco de dados deve ser excluído ou desanexado após a exclusão da VM. Os valores possíveis são: Excluir. Se esse valor for usado, o disco de dados será excluído quando a VM for excluída. Destacar. Se esse valor for usado, o disco de dados será retido após a exclusão da VM. 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 anexado 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.

Nome Tipo Description
detachOption

DiskDetachOptionTypes

Opções com suporte 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 Description
Local

DiffDiskPlacement

Especifica o posicionamento de disco efêmero para o disco do sistema operacional. Essa 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 os requisitos de tamanho de disco do sistema operacional efêmero para vm do Windows e https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements VM linux em 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 Description
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. Observação: as configurações de disco efêmero só podem ser especificadas para o disco gerenciado.

Nome Tipo Description
option

DiffDiskOptions

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

placement

DiffDiskPlacement

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

DiskControllerTypes

Especifica o tipo de controlador de disco configurado para a VM e VirtualMachineScaleSet. Essa propriedade só tem suporte para máquinas virtuais cujo disco do sistema operacional e sku de VM dá suporte à Geração 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), verifique se a funcionalidade HyperVGenerations retornada como parte dos recursos de sku de VM na resposta da API de SKUs da 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 com suporte, consulte https://aka.ms/azure-diskcontrollertypes.

Valor Description
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ê está usando um disco especializado para criar a máquina virtual. FromImage: Esse valor é usado quando você está usando uma imagem para criar a máquina virtual. Se você estiver usando uma imagem de plataforma, também deverá usar o elemento imageReference descrito acima. Se você estiver usando uma imagem do marketplace, também deverá usar o elemento de plano descrito anteriormente. Vazio: Esse valor é usado ao criar um disco de dados vazio. Cópia: Esse valor é usado para criar um disco de dados a partir de um instantâneo ou outro disco. Restaurar: esse valor é usado para criar um disco de dados a partir de um ponto de restauração de disco.

Valor Description
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 com suporte são: Excluir. 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á mantido após a exclusão da VM. Versão mínima da API: 2021-03-01.

Valor Description
Delete
Detach

DiskDetachOptionTypes

Especifica o comportamento de desanexar a ser usado ao desanexar um disco ou que já está em processo de desanexação da máquina virtual. Os valores com suporte são: ForceDetach. detachOption: ForceDetach é aplicável somente a discos de dados gerenciados. Se uma tentativa de desanexação anterior do disco de dados não tiver sido concluída devido a uma falha inesperada da máquina virtual e o disco ainda não for 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 desanexar. Esse recurso ainda está em versão prévia. Para forçar a desanexação de uma atualização de disco de dados paraBeDetached como 'true' juntamente com a configuração de detachOption: 'ForceDetach'.

Valor Description
ForceDetach

DiskEncryptionSetParameters

Descreve o parâmetro da ID de recurso do conjunto de criptografia de disco gerenciado pelo cliente que pode ser especificada para disco. Observação: A ID do recurso do conjunto de criptografia de disco só pode ser especificada para o disco gerenciado. Consulte https://aka.ms/mdssewithcmkoverview para obter mais detalhes.

Nome Tipo Description
id

string

ID do recurso

DiskEncryptionSettings

Descreve as configurações de criptografia de um disco

Nome Tipo Description
diskEncryptionKey

KeyVaultSecretReference

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

enabled

boolean

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

keyEncryptionKey

KeyVaultKeyReference

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

ImageReference

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

Nome Tipo Description
communityGalleryImageId

string

Especifica a ID exclusiva da imagem da galeria da comunidade para implantação de VM. Isso pode ser buscado na chamada GET da imagem da galeria da comunidade.

exactVersion

string

Especifica em números decimais, a versão da imagem da plataforma ou da imagem do marketplace usada para criar a máquina virtual. Esse campo readonly difere de 'version', somente se o valor especificado no campo 'version' for 'latest'.

id

string

ID do recurso

offer

string

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

publisher

string

O editor de imagens.

sharedGalleryImageId

string

Especifica a ID exclusiva da imagem da galeria compartilhada para implantação de VM. Isso pode ser buscado na chamada GET da imagem da galeria compartilhada.

sku

string

A SKU da imagem.

version

string

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

InnerError

Detalhes do erro interno.

Nome Tipo Description
errordetail

string

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

exceptiontype

string

O tipo de exceção.

KeyVaultKeyReference

Descreve uma referência à chave do Key Vault

Nome Tipo Description
keyUrl

string

A URL que faz referência a uma chave de criptografia de chave no Key Vault.

sourceVault

SubResource

A URL relativa do Key Vault que contém a chave.

KeyVaultSecretReference

Descreve uma referência ao Segredo do Key Vault

Nome Tipo Description
secretUrl

string

A URL que faz referência a um segredo em um Key Vault.

sourceVault

SubResource

A URL relativa do Key Vault que contém o segredo.

ManagedDiskParameters

Os parâmetros de um disco gerenciado.

Nome Tipo Description
diskEncryptionSet

DiskEncryptionSetParameters

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

id

string

ID do recurso

securityProfile

VMDiskSecurityProfile

Especifica o perfil de segurança do disco gerenciado.

storageAccountType

StorageAccountTypes

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

OperatingSystemTypes

Essa propriedade permite que você especifique o tipo do sistema operacional incluído no disco se criar uma VM com base na imagem do usuário ou em um VHD especializado. Os valores possíveis são: Windows,Linux.

Valor Description
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.

Nome Tipo Description
caching

CachingTypes

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

createOption

DiskCreateOptionTypes

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

deleteOption

DiskDeleteOptionTypes

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

diffDiskSettings

DiffDiskSettings

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

diskSizeGB

integer (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 da imagem do usuário de origem. O disco rígido virtual será copiado antes de ser anexado à máquina virtual. Se SourceImage for fornecido, o disco rígido virtual de destino não deverá existir.

managedDisk

ManagedDiskParameters

Os parâmetros de disco gerenciado.

name

string

O nome do disco.

osType

OperatingSystemTypes

Essa propriedade permite que você especifique o tipo do sistema operacional incluído no disco se criar uma VM com base na imagem do usuário ou em um VHD especializado. Os valores possíveis são: Windows,Linux.

vhd

VirtualHardDisk

O disco rígido virtual.

writeAcceleratorEnabled

boolean

Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco.

SecurityEncryptionTypes

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

Valor Description
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 dimensionamento. OBSERVAÇÃO: UltraSSD_LRS só pode ser usado com discos de dados. Ele não pode ser usado com o disco do sistema operacional. Standard_LRS usa o HDD Standard. StandardSSD_LRS usa o SSD Standard. Premium_LRS usa o SSD Premium. UltraSSD_LRS usa disco Ultra. Premium_ZRS usa o armazenamento com redundância de zona SSD Premium. StandardSSD_ZRS usa o armazenamento com redundância de zona SSD Standard. Para obter mais informações sobre discos com suporte 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 Description
Standard_LRS
Premium_LRS
StandardSSD_LRS
UltraSSD_LRS
Premium_ZRS
StandardSSD_ZRS
PremiumV2_LRS

StorageProfile

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

Nome Tipo Description
alignRegionalDisksToVMZone

boolean

Especifica se os discos regionais devem ser alinhados/movidos para a zona da VM. Isso é aplicável somente para VMs com conjunto de propriedades de posicionamento. Observe que essa alteração é irreversível. Versão mínima da API: 2024-11-01.

dataDisks

DataDisk[]

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

diskControllerType

DiskControllerTypes

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

imageReference

ImageReference

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

osDisk

OSDisk

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

SubResource

Nome Tipo Description
id

string

ID do recurso

VirtualHardDisk

Descreve o uri de um disco.

Nome Tipo Description
uri

string

Especifica o uri do disco rígido virtual.

VMDiskSecurityProfile

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

Nome Tipo Description
diskEncryptionSet

DiskEncryptionSetParameters

Especifica a ID do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado usado para a Chave Gerenciada pelo Cliente criptografado disco do sistema operacional ConfidentialVM e blob VMGuest.

securityEncryptionType

SecurityEncryptionTypes

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