Restore Point Collections - Create Or Update

A operação para criar ou atualizar a coleção de pontos de restauração. Consulte https://aka.ms/RestorePoints para obter mais detalhes. Ao atualizar uma coleção de pontos de restauração, apenas as tags podem ser modificadas.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}?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.

restorePointCollectionName
path True

string

O nome da coleção de pontos de restauração.

subscriptionId
path True

string

minLength: 1

O ID da assinatura de destino.

api-version
query True

string

minLength: 1

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

Corpo do Pedido

Name Obrigatório Tipo Descrição
location True

string

A geolocalização onde o recurso vive

properties.instantAccess

boolean

Esta propriedade determina se o instantâneo de acesso instantâneo está habilitado para pontos de restauração criados sob essa coleção de pontos de restauração para SSD Premium v2 ou disco Ultra. O instantâneo de acesso instantâneo para SSD Premium v2 ou disco Ultra está disponível instantaneamente para restaurar o disco com desempenho de restauração rápido.

properties.source

RestorePointCollectionSourceProperties

As propriedades do recurso de origem a partir do qual esta coleção de pontos de restauração é criada.

tags

object

Tags de recursos.

Respostas

Name Tipo Descrição
200 OK

RestorePointCollection

Operação de atualização do recurso 'RestorePointCollection' bem-sucedida

201 Created

RestorePointCollection

Recurso 'RestorePointCollection' criar operação bem-sucedida

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

Create or update a restore point collection for cross region copy.
Create or update a restore point collection.

Create or update a restore point collection for cross region copy.

Pedido de amostra

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc?api-version=2026-04-01

{
  "location": "norwayeast",
  "properties": {
    "source": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName"
    }
  },
  "tags": {
    "myTag1": "tagValue1"
  }
}

Resposta da amostra

{
  "name": "myRpc",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
  "type": "Microsoft.Compute/restorePointCollections",
  "location": "norwayeast",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "source": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
      "location": "eastus"
    },
    "restorePointCollectionId": "638f052b-a7c2-450c-89e7-6a3b8f1d6a7c",
    "provisioningState": "Succeeded"
  }
}
{
  "name": "myRpc",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
  "type": "Microsoft.Compute/restorePointCollections",
  "location": "norwayeast",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "source": {
      "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName",
      "location": "eastus"
    },
    "restorePointCollectionId": "638f052b-a7c2-450c-89e7-6a3b8f1d6a7c",
    "provisioningState": "Succeeded"
  }
}

Create or update a restore point collection.

Pedido de amostra

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc?api-version=2026-04-01

{
  "location": "norwayeast",
  "properties": {
    "source": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"
    },
    "instantAccess": true
  },
  "tags": {
    "myTag1": "tagValue1"
  }
}

Resposta da amostra

{
  "name": "myRpc",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
  "type": "Microsoft.Compute/restorePointCollections",
  "location": "norwayeast",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "source": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
      "location": "eastus"
    },
    "instantAccess": true,
    "restorePointCollectionId": "638f052b-a7c2-450c-89e7-6a3b8f1d6a7c",
    "provisioningState": "Succeeded"
  }
}
{
  "name": "myRpc",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
  "type": "Microsoft.Compute/restorePointCollections",
  "location": "norwayeast",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "source": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
      "location": "eastus"
    },
    "instantAccess": true,
    "restorePointCollectionId": "638f052b-a7c2-450c-89e7-6a3b8f1d6a7c",
    "provisioningState": "Succeeded"
  }
}

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.

AdditionalUnattendContent

Especifica informações adicionais formatadas em XML que podem ser incluídas no arquivo Unattend.xml, que é usado pela Instalação do Windows. O conteúdo é definido definindo o nome, o nome do componente e a passagem na qual o conteúdo é aplicado.

ApiEntityReference

A referência da entidade da API.

ApiError

Erro de api.

ApiErrorBase

Base de erro da api.

AvailabilityPolicyDiskDelay

Determina como lidar com discos com I/O lento.

BootDiagnostics

O Diagnóstico de Inicialização é um recurso de depuração que permite visualizar a saída do console e a captura de tela para diagnosticar o status da VM. Você pode visualizar facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor.

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.

ComponentNames
ConsistencyModeTypes

ConsistencyMode do RestorePoint. Pode ser especificado na entrada durante a criação de um ponto de restauração. Por enquanto, apenas CrashConsistent é aceito como uma entrada válida. Consulte https://aka.ms/RestorePoints para obter mais detalhes.

createdByType

O tipo de identidade que criou o recurso.

DiagnosticsProfile

Especifica o estado das configurações de diagnóstico de inicialização. Versão mínima da api: 2015-06-15.

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.

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

DiskRestorePointAttributes

Detalhes do ponto de restauração do disco.

DiskRestorePointInstanceView

A exibição de instância de um ponto de restauração de disco.

DiskRestorePointReplicationStatus

A exibição de instância de um ponto de restauração de disco.

EncryptionIdentity

Especifica a Identidade Gerenciada usada pelo ADE para obter o token de acesso para operações keyvault.

HardwareProfile

Especifica as configurações de hardware para a máquina virtual.

HostEndpointSettings

Especifica configurações específicas do ponto de extremidade do host.

HyperVGenerationTypes

Especifica o tipo HyperVGeneration

InnerError

Detalhes do erro interno.

InstanceViewStatus

Status da exibição da instância.

KeyVaultKeyReference

Descreve uma referência à chave do cofre da chave

KeyVaultSecretReference

Descreve uma referência ao segredo do Key Vault

LinuxConfiguration

Especifica as configurações do sistema operacional Linux na máquina virtual. Para obter uma lista de distribuições Linux suportadas, consulte Linux on Azure-Endorsed Distributions.

LinuxPatchAssessmentMode

Especifica o modo de Avaliação de Patch de Convidado de VM para a máquina virtual IaaS.

Os valores possíveis são:

ImageDefault - Você controla o tempo das avaliações de patch em uma máquina virtual.

AutomaticByPlatform - A plataforma acionará avaliações periódicas de patches. A provisão de propriedadeVMAgent deve ser true.

LinuxPatchSettings

Especifica as configurações relacionadas ao Patch de convidado de VM no Linux.

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Especifica a configuração de reinicialização para todas as operações de instalação do patch AutomaticByPlatform.

LinuxVMGuestPatchAutomaticByPlatformSettings

Especifica configurações adicionais a serem aplicadas quando o modo de patch AutomaticByPlatform é selecionado nas configurações de patch do Linux.

LinuxVMGuestPatchMode

Especifica o modo de aplicação de patches de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquina virtual com OrchestrationMode como flexível.

Os valores possíveis são:

ImageDefault - A configuração de patch padrão da máquina virtual é usada.

AutomaticByPlatform - A máquina virtual será atualizada automaticamente pela plataforma. A provisão de propriedadeVMAgent deve ser true

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.

Mode

Especifica o modo em que o ProxyAgent será executado se o recurso estiver habilitado. O ProxyAgent começará a auditar ou monitorar, mas não a impor o controle de acesso sobre solicitações para hospedar pontos de extremidade no modo de Auditoria, enquanto no modo Enforce ele imporá o controle de acesso. O valor padrão é Enforce mode.

Modes

Especifica o modo de execução. No modo de auditoria, o sistema age como se estivesse aplicando a política de controle de acesso, incluindo a emissão de entradas de negação de acesso nos logs, mas na verdade não nega nenhuma solicitação para hospedar pontos de extremidade. No modo Enforce, o sistema irá impor o controle de acesso e é o modo recomendado de operação.

NetworkAccessPolicy

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

OperatingSystemType

Obtém o tipo de sistema operacional.

OSProfile

Especifica as configurações do sistema operacional para a máquina virtual. Algumas das configurações não podem ser alteradas depois que a VM é provisionada.

PassNames
PatchSettings

Especifica as configurações relacionadas ao patch de convidado de VM no Windows.

ProcessorMode

Especifica o comportamento da frequência do processador para a máquina virtual. Veja cada membro para o comportamento que controla.

ProtocolTypes

Especifica o protocolo do ouvinte do WinRM. Os valores possíveis são: httphttps.

ProxyAgentSettings

Especifica as configurações do ProxyAgent para a máquina virtual ou o conjunto de dimensionamento da máquina virtual. Versão mínima da api: 2023-09-01.

RestorePoint

Detalhes do ponto de restauração.

RestorePointCollection

Crie ou atualize os parâmetros da coleção Restore Point.

RestorePointCollectionSourceProperties

As propriedades do recurso de origem a partir do qual esta coleção de pontos de restauração é criada.

RestorePointEncryption

Configurações de criptografia em repouso para o ponto de restauração do disco. É uma propriedade opcional que pode ser especificada na entrada durante a criação de um ponto de restauração.

RestorePointEncryptionType

O tipo de chave usada para criptografar os dados do ponto de restauração do disco.

RestorePointInstanceView

A exibição de instância de um ponto de restauração.

RestorePointSourceMetadata

Descreve as propriedades da máquina virtual para a qual o ponto de restauração foi criado. As propriedades fornecidas são um subconjunto e o instantâneo das propriedades gerais da Máquina Virtual capturadas no momento da criação do ponto de restauração.

RestorePointSourceVMDataDisk

Descreve um disco de dados.

RestorePointSourceVMOSDisk

Descreve um disco do sistema operacional.

RestorePointSourceVMStorageProfile

Descreve o perfil de armazenamento.

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.

SecurityProfile

Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento da máquina virtual.

SecurityTypes

Especifica o tipo de segurança da VM; As UefiSettings só estão ativadas quando definidas para TrustedLaunch ou ConfidentialVM, e retornam um valor Standard a partir da versão da API a partir de 2025-11-01.

SettingNames

Especifica o nome da configuração à qual o conteúdo se aplica. Os valores possíveis são: FirstLogonCommands e AutoLogon.

SnapshotAccessState

O estado do snapshot que determina a disponibilidade de acesso do snapshot.

SshConfiguration

Configuração SSH para VMs baseadas em Linux em execução no Azure

SshPublicKey

Contém informações sobre a chave pública do certificado SSH e o caminho na VM Linux onde a chave pública é colocada.

StatusLevelTypes

O código de nível.

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

SubResource
systemData

Metadados referentes à criação e última modificação do recurso.

UefiSettings

Especifica as configurações de segurança, como inicialização segura e vTPM, usadas durante a criação da máquina virtual. Versão api mínima: 2020-12-01.

VaultCertificate

Descreve uma única referência de certificado em um Cofre de Chaves e onde o certificado deve residir na VM.

VaultSecretGroup

Descreve um conjunto de certificados que estão todos no mesmo Cofre de Chaves.

VirtualMachineSizeTypes

Especifica o tamanho da máquina virtual. O tipo de dados enum está atualmente preterido e será removido até 23 de dezembro de 2023. A maneira recomendada de obter a lista de tamanhos disponíveis é usando estas APIs: Listar todos os tamanhos de máquina virtual disponíveis em um conjunto de disponibilidade, Listar todos os tamanhos de máquina virtual disponíveis em uma regiãoListar todos os tamanhos de máquina virtual disponíveis para redimensionamento. Para obter mais informações sobre tamanhos de máquinas virtuais, consulte tamanhos para máquinas virtuais. Os tamanhos de VM disponíveis dependem da região e do conjunto de disponibilidade.

VMDiskSecurityProfile

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

VMSizeProperties

Especifica as configurações da Propriedade de Tamanho da VM na máquina virtual.

WindowsConfiguration

Especifica as configurações do sistema operacional Windows na máquina virtual.

WindowsPatchAssessmentMode

Especifica o modo de avaliação de patch do convidado da VM para a máquina virtual IaaS.

Os valores possíveis são:

ImageDefault - Você controla o tempo das avaliações de patch em uma máquina virtual.

AutomaticByPlatform - A plataforma acionará avaliações periódicas de patches. A provisão de propriedadeVMAgent deve ser true.

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Especifica a configuração de reinicialização para todas as operações de instalação do patch AutomaticByPlatform.

WindowsVMGuestPatchAutomaticByPlatformSettings

Especifica configurações adicionais a serem aplicadas quando o modo de patch AutomaticByPlatform é selecionado nas configurações de patch do Windows.

WindowsVMGuestPatchMode

Especifica o modo de aplicação de patches de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquina virtual com OrchestrationMode como flexível.

Os valores possíveis são:

Manual - Você controla a aplicação de patches em uma máquina virtual. Para fazer isso, aplique patches manualmente dentro da VM. Neste modo, as atualizações automáticas são desativadas; a propriedade WindowsConfiguration.enableAutomaticUpdates deve ser false

AutomaticByOS - A máquina virtual será atualizada automaticamente pelo SO. A propriedade WindowsConfiguration.enableAutomaticUpdates deve ser true.

AutomaticByPlatform - a máquina virtual será atualizada automaticamente pela plataforma. As propriedades provisionVMAgent e WindowsConfiguration.enableAutomaticUpdates devem ser true

WinRMConfiguration

Descreve a configuração do Gerenciamento Remoto do Windows da VM

WinRMListener

Descreve o protocolo e a impressão digital do ouvinte do Gerenciamento Remoto do Windows

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.

AdditionalUnattendContent

Especifica informações adicionais formatadas em XML que podem ser incluídas no arquivo Unattend.xml, que é usado pela Instalação do Windows. O conteúdo é definido definindo o nome, o nome do componente e a passagem na qual o conteúdo é aplicado.

Name Tipo Descrição
componentName

ComponentNames

O nome do componente. Atualmente, o único valor permitido é Microsoft-Windows-Shell-Setup.

content

string

Especifica o conteúdo formatado em XML que é adicionado ao arquivo de unattend.xml para o caminho e o componente especificados. O XML deve ter menos de 4KB e deve incluir o elemento raiz para a configuração ou recurso que está sendo inserido.

passName

PassNames

O nome do passe. Atualmente, o único valor permitido é OobeSystem.

settingName

SettingNames

Especifica o nome da configuração à qual o conteúdo se aplica. Os valores possíveis são: FirstLogonCommands e AutoLogon.

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.

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.

BootDiagnostics

O Diagnóstico de Inicialização é um recurso de depuração que permite visualizar a saída do console e a captura de tela para diagnosticar o status da VM. Você pode visualizar facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor.

Name Tipo Descrição
enabled

boolean

Se o diagnóstico de inicialização deve ser habilitado na máquina virtual.

storageUri

string

Uri da conta de armazenamento a ser usada para colocar a saída do console e a captura de tela. Se storageUri não for especificado ao habilitar o diagnóstico de inicialização, o armazenamento gerenciado será usado.

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.

ComponentNames

Valor Descrição
Microsoft-Windows-Shell-Setup

ConsistencyModeTypes

ConsistencyMode do RestorePoint. Pode ser especificado na entrada durante a criação de um ponto de restauração. Por enquanto, apenas CrashConsistent é aceito como uma entrada válida. Consulte https://aka.ms/RestorePoints para obter mais detalhes.

Valor Descrição
CrashConsistent
FileSystemConsistent
ApplicationConsistent

createdByType

O tipo de identidade que criou o recurso.

Valor Descrição
User
Application
ManagedIdentity
Key

DiagnosticsProfile

Especifica o estado das configurações de diagnóstico de inicialização. Versão mínima da api: 2015-06-15.

Name Tipo Descrição
bootDiagnostics

BootDiagnostics

O Diagnóstico de Inicialização é um recurso de depuração que permite visualizar a saída do console e a captura de tela para diagnosticar o status da VM. NOTA: Se storageUri estiver sendo especificado, verifique se a conta de armazenamento está na mesma região e assinatura que a VM. Você pode visualizar facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor.

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

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.

DiskRestorePointAttributes

Detalhes do ponto de restauração do disco.

Name Tipo Descrição
encryption

RestorePointEncryption

Configurações de criptografia em repouso para o ponto de restauração do disco. É uma propriedade opcional que pode ser especificada na entrada durante a criação de um ponto de restauração.

id

string

ID do recurso

sourceDiskRestorePoint

ApiEntityReference

ID do recurso do ponto de restauração do disco de origem.

DiskRestorePointInstanceView

A exibição de instância de um ponto de restauração de disco.

Name Tipo Descrição
id

string

Id do ponto de restauração do disco.

replicationStatus

DiskRestorePointReplicationStatus

As informações de status de replicação do ponto de restauração de disco.

snapshotAccessState

SnapshotAccessState

O estado do snapshot que determina a disponibilidade de acesso do snapshot.

DiskRestorePointReplicationStatus

A exibição de instância de um ponto de restauração de disco.

Name Tipo Descrição
completionPercent

integer (int32)

Porcentagem de conclusão da replicação.

status

InstanceViewStatus

As informações de status do recurso.

EncryptionIdentity

Especifica a Identidade Gerenciada usada pelo ADE para obter o token de acesso para operações keyvault.

Name Tipo Descrição
userAssignedIdentityResourceId

string

Especifica a ID de recurso ARM de uma das identidades de usuário associadas à VM.

HardwareProfile

Especifica as configurações de hardware para a máquina virtual.

Name Tipo Descrição
processorMode

ProcessorMode

Especifica o modo de processador para a máquina virtual ou o conjunto de escalas da máquina virtual. Opcional; se for omitido, aplica-se o padrão da plataforma (atualmente Determinístico). Esta propriedade pode ser atualizada numa VM ou VMSS em execução sem desalocação ou reinicialização. Versão mínima da API: 01-04-2026.

vmSize

VirtualMachineSizeTypes

Especifica o tamanho da máquina virtual. O tipo de dados enum está atualmente preterido e será removido até 23 de dezembro de 2023. A maneira recomendada de obter a lista de tamanhos disponíveis é usando estas APIs: Listar todos os tamanhos de máquina virtual disponíveis em um conjunto de disponibilidade, Listar todos os tamanhos de máquina virtual disponíveis em uma regiãoListar todos os tamanhos de máquina virtual disponíveis para redimensionamento. Para obter mais informações sobre tamanhos de máquinas virtuais, consulte tamanhos para máquinas virtuais. Os tamanhos de VM disponíveis dependem da região e do conjunto de disponibilidade.

vmSizeProperties

VMSizeProperties

Especifica as propriedades para personalizar o tamanho da máquina virtual. Versão mínima api: 2021-07-01. Esse recurso ainda está no modo de visualização e não é suportado para VirtualMachineScaleSet. Siga as instruções em de personalização de VM para obter mais detalhes.

HostEndpointSettings

Especifica configurações específicas do ponto de extremidade do host.

Name Tipo Descrição
inVMAccessControlProfileReferenceId

string

Especifica a id do recurso InVMAccessControlProfileVersion no formato /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}

mode

Modes

Especifica o modo de execução. No modo de auditoria, o sistema age como se estivesse aplicando a política de controle de acesso, incluindo a emissão de entradas de negação de acesso nos logs, mas na verdade não nega nenhuma solicitação para hospedar pontos de extremidade. No modo Enforce, o sistema irá impor o controle de acesso e é o modo recomendado de operação.

useLocalFileRules

boolean

Quando definido como true, instrui o GuestProxyAgent dentro da VM a carregar regras adicionais de controlo de acesso definidas num ficheiro local na VM.

HyperVGenerationTypes

Especifica o tipo HyperVGeneration

Valor Descrição
V1
V2

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.

InstanceViewStatus

Status da exibição da instância.

Name Tipo Descrição
code

string

O código de status.

displayStatus

string

O rótulo curto localizável para o status.

level

StatusLevelTypes

O código de nível.

message

string

A mensagem de status detalhada, inclusive para alertas e mensagens de erro.

time

string (date-time)

A hora do status.

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.

LinuxConfiguration

Especifica as configurações do sistema operacional Linux na máquina virtual. Para obter uma lista de distribuições Linux suportadas, consulte Linux on Azure-Endorsed Distributions.

Name Tipo Descrição
disablePasswordAuthentication

boolean

Especifica se a autenticação de senha deve ser desabilitada.

enableVMAgentPlatformUpdates

boolean

Indica se as Atualizações da Plataforma VMAgent estão habilitadas para a máquina virtual Linux. O valor predefinido é falso.

patchSettings

LinuxPatchSettings

[Funcionalidade de pré-visualização] Especifica as configurações relacionadas ao Patch de convidado de VM no Linux.

provisionVMAgent

boolean

Indica se o agente de máquina virtual deve ser provisionado na máquina virtual. Quando essa propriedade não é especificada no corpo da solicitação, o comportamento padrão é defini-la como true. Isso garantirá que o Agente de VM seja instalado na VM para que as extensões possam ser adicionadas à VM posteriormente.

ssh

SshConfiguration

Especifica a configuração da chave ssh para um sistema operacional Linux.

LinuxPatchAssessmentMode

Especifica o modo de Avaliação de Patch de Convidado de VM para a máquina virtual IaaS.

Os valores possíveis são:

ImageDefault - Você controla o tempo das avaliações de patch em uma máquina virtual.

AutomaticByPlatform - A plataforma acionará avaliações periódicas de patches. A provisão de propriedadeVMAgent deve ser true.

Valor Descrição
ImageDefault
AutomaticByPlatform

LinuxPatchSettings

Especifica as configurações relacionadas ao Patch de convidado de VM no Linux.

Name Tipo Descrição
assessmentMode

LinuxPatchAssessmentMode

Especifica o modo de Avaliação de Patch de Convidado de VM para a máquina virtual IaaS.

Os valores possíveis são:

ImageDefault - Você controla o tempo das avaliações de patch em uma máquina virtual.

AutomaticByPlatform - A plataforma acionará avaliações periódicas de patches. A provisão de propriedadeVMAgent deve ser true.

automaticByPlatformSettings

LinuxVMGuestPatchAutomaticByPlatformSettings

Especifica configurações adicionais para o modo de patch AutomaticByPlatform no VM Guest Patching no Linux.

patchMode

LinuxVMGuestPatchMode

Especifica o modo de aplicação de patches de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquina virtual com OrchestrationMode como flexível.

Os valores possíveis são:

ImageDefault - A configuração de patch padrão da máquina virtual é usada.

AutomaticByPlatform - A máquina virtual será atualizada automaticamente pela plataforma. A provisão de propriedadeVMAgent deve ser true

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Especifica a configuração de reinicialização para todas as operações de instalação do patch AutomaticByPlatform.

Valor Descrição
Unknown
IfRequired
Never
Always

LinuxVMGuestPatchAutomaticByPlatformSettings

Especifica configurações adicionais a serem aplicadas quando o modo de patch AutomaticByPlatform é selecionado nas configurações de patch do Linux.

Name Tipo Descrição
bypassPlatformSafetyChecksOnUserSchedule

boolean

Permite que o cliente agende patches sem atualizações acidentais

rebootSetting

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Especifica a configuração de reinicialização para todas as operações de instalação do patch AutomaticByPlatform.

LinuxVMGuestPatchMode

Especifica o modo de aplicação de patches de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquina virtual com OrchestrationMode como flexível.

Os valores possíveis são:

ImageDefault - A configuração de patch padrão da máquina virtual é usada.

AutomaticByPlatform - A máquina virtual será atualizada automaticamente pela plataforma. A provisão de propriedadeVMAgent deve ser true

Valor Descrição
ImageDefault
AutomaticByPlatform

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.

Mode

Especifica o modo em que o ProxyAgent será executado se o recurso estiver habilitado. O ProxyAgent começará a auditar ou monitorar, mas não a impor o controle de acesso sobre solicitações para hospedar pontos de extremidade no modo de Auditoria, enquanto no modo Enforce ele imporá o controle de acesso. O valor padrão é Enforce mode.

Valor Descrição
Audit
Enforce

Modes

Especifica o modo de execução. No modo de auditoria, o sistema age como se estivesse aplicando a política de controle de acesso, incluindo a emissão de entradas de negação de acesso nos logs, mas na verdade não nega nenhuma solicitação para hospedar pontos de extremidade. No modo Enforce, o sistema irá impor o controle de acesso e é o modo recomendado de operação.

Valor Descrição
Audit
Enforce
Disabled

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.

OperatingSystemType

Obtém o tipo de sistema operacional.

Valor Descrição
Windows
Linux

OSProfile

Especifica as configurações do sistema operacional para a máquina virtual. Algumas das configurações não podem ser alteradas depois que a VM é provisionada.

Name Tipo Descrição
adminPassword

string (password)

Especifica a senha da conta de administrador.

Comprimento mínimo (Windows): 8 caracteres

Comprimento mínimo (Linux): 6 caracteres

Max-length (Windows): 123 caracteres

Max-length (Linux): 72 caracteres

Requisitos de complexidade: 3 das 4 condições abaixo precisam ser cumpridas
Tem caracteres mais baixos
Tem caracteres superiores
Tem um dígito
Tem um caractere especial (Regex match [\W_])

Valores não permitidos: "abc@123", "P@$$w 0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

Para redefinir a senha, consulte Como redefinir o serviço de Área de Trabalho Remota ou sua senha de login em uma VM do Windows

Para redefinir a senha de root, consulte Gerenciar usuários, SSH e verificar ou reparar discos em VMs Linux do Azure usando a Extensão VMAccess

adminUsername

string

Especifica o nome da conta de administrador.

Essa propriedade não pode ser atualizada depois que a VM é criada.

Restrição somente para Windows: Não pode terminar em "."

Valores não permitidos: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

Comprimento mínimo (Linux): 1 caractere

Max-length (Linux): 64 caracteres

Comprimento máximo (Windows): 20 caracteres.

allowExtensionOperations

boolean

Especifica se as operações de extensão devem ser permitidas na máquina virtual. Isso só pode ser definido como Falso quando nenhuma extensão estiver presente na máquina virtual.

computerName

string

Especifica o nome do sistema operacional host da máquina virtual. Esse nome não pode ser atualizado após a criação da VM. Comprimento máximo (Windows): 15 caracteres. Max-length (Linux): 64 caracteres. Para convenções e restrições de nomenclatura, consulte diretrizes de implementação de serviços de infraestrutura do Azure.

customData

string

Especifica uma cadeia de caracteres codificada em base 64 de dados personalizados. A cadeia de caracteres codificada em base 64 é decodificada para uma matriz binária que é salva como um arquivo na máquina virtual. O comprimento máximo da matriz binária é de 65535 bytes. Nota: Não passe segredos ou senhas na propriedade customData. Essa propriedade não pode ser atualizada depois que a VM é criada. A propriedade 'customData' é passada para a VM para ser salva como um arquivo, para obter mais informações, consulte Dados Personalizados em VMs do Azure. Para usar cloud-init para sua VM Linux, consulte Usando cloud-init para personalizar uma VM Linux durante a criação.

linuxConfiguration

LinuxConfiguration

Especifica as configurações do sistema operacional Linux na máquina virtual. Para obter uma lista de distribuições Linux suportadas, consulte Linux on Azure-Endorsed Distributions.

requireGuestProvisionSignal

boolean

Propriedade opcional que deve ser definida como True ou omitida.

secrets

VaultSecretGroup[]

Especifica o conjunto de certificados que devem ser instalados na máquina virtual. Para instalar certificados em uma máquina virtual, é recomendável usar a extensão de máquina virtual do Azure Key Vault para Linux ou a extensão de máquina virtual do Azure Key Vault para Windows.

windowsConfiguration

WindowsConfiguration

Especifica as configurações do sistema operacional Windows na máquina virtual.

PassNames

Valor Descrição
OobeSystem

PatchSettings

Especifica as configurações relacionadas ao patch de convidado de VM no Windows.

Name Tipo Descrição
assessmentMode

WindowsPatchAssessmentMode

Especifica o modo de avaliação de patch do convidado da VM para a máquina virtual IaaS.

Os valores possíveis são:

ImageDefault - Você controla o tempo das avaliações de patch em uma máquina virtual.

AutomaticByPlatform - A plataforma acionará avaliações periódicas de patches. A provisão de propriedadeVMAgent deve ser true.

automaticByPlatformSettings

WindowsVMGuestPatchAutomaticByPlatformSettings

Especifica configurações adicionais para o modo de patch AutomaticByPlatform no VM Guest Patching no Windows.

enableHotpatching

boolean

Permite que os clientes corrijam suas VMs do Azure sem exigir uma reinicialização. Para enableHotpatching, o 'provisionVMAgent' deve ser definido como true e 'patchMode' deve ser definido como 'AutomaticByPlatform'.

patchMode

WindowsVMGuestPatchMode

Especifica o modo de aplicação de patches de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquina virtual com OrchestrationMode como flexível.

Os valores possíveis são:

Manual - Você controla a aplicação de patches em uma máquina virtual. Para fazer isso, aplique patches manualmente dentro da VM. Neste modo, as atualizações automáticas são desativadas; a propriedade WindowsConfiguration.enableAutomaticUpdates deve ser false

AutomaticByOS - A máquina virtual será atualizada automaticamente pelo SO. A propriedade WindowsConfiguration.enableAutomaticUpdates deve ser true.

AutomaticByPlatform - a máquina virtual será atualizada automaticamente pela plataforma. As propriedades provisionVMAgent e WindowsConfiguration.enableAutomaticUpdates devem ser true

ProcessorMode

Especifica o comportamento da frequência do processador para a máquina virtual. Veja cada membro para o comportamento que controla.

Valor Descrição
Deterministic

Assegura uma frequência de processador previsível e consistente ao nível base/nominal. Turbo/Boost está desativado.

Opportunistic

Permite rajadas de frequência mais elevada quando a margem térmica e de potência o permite.

ProtocolTypes

Especifica o protocolo do ouvinte do WinRM. Os valores possíveis são: httphttps.

Valor Descrição
Http
Https

ProxyAgentSettings

Especifica as configurações do ProxyAgent para a máquina virtual ou o conjunto de dimensionamento da máquina virtual. Versão mínima da api: 2023-09-01.

Name Tipo Descrição
addProxyAgentExtension

boolean

Especifique se deseja instalar implicitamente a extensão ProxyAgent. Atualmente, esta opção é aplicável apenas para Linux OS.

enabled

boolean

Especifica se o recurso ProxyAgent deve ser habilitado na máquina virtual ou no conjunto de dimensionamento da máquina virtual.

imds

HostEndpointSettings

Especifica as configurações do ponto de extremidade IMDS ao criar a máquina virtual ou o conjunto de dimensionamento da máquina virtual. Versão api mínima: 2024-03-01.

keyIncarnationId

integer (int32)

Aumentar o valor dessa propriedade permite que os usuários redefina a chave usada para proteger o canal de comunicação entre convidado e host.

mode

Mode

Especifica o modo em que o ProxyAgent será executado. Aviso: esta propriedade foi preterida, especifique 'modo' em particular configuração hostendpoint.

wireServer

HostEndpointSettings

Especifica as configurações do ponto de extremidade do Wire Server durante a criação da máquina virtual ou do conjunto de dimensionamento da máquina virtual. Versão api mínima: 2024-03-01.

RestorePoint

Detalhes do ponto de restauração.

Name Tipo Descrição
id

string

ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

O nome do recurso

properties.consistencyMode

ConsistencyModeTypes

ConsistencyMode do RestorePoint. Pode ser especificado na entrada durante a criação de um ponto de restauração. Por enquanto, apenas CrashConsistent é aceito como uma entrada válida. Consulte https://aka.ms/RestorePoints para obter mais detalhes.

properties.excludeDisks

ApiEntityReference[]

Lista de ids de recursos de disco que o cliente deseja excluir do ponto de restauração. Se nenhum disco for especificado, todos os discos serão incluídos.

properties.instanceView

RestorePointInstanceView

A exibição da instância do ponto de restauração.

properties.instantAccessDurationMinutes

integer (int32)

Esta propriedade determina o tempo, em minutos, que o instantâneo é retido como acesso instantâneo para restaurar o disco SSD Premium v2 ou Ultra com desempenho de restauração rápido neste ponto de restauração.

properties.provisioningState

string

Obtém o estado de provisionamento do ponto de restauração.

properties.sourceMetadata

RestorePointSourceMetadata

Obtém os detalhes da VM capturados no momento da criação do ponto de restauração.

properties.sourceRestorePoint

ApiEntityReference

ID do recurso do ponto de restauração de origem a partir do qual uma cópia precisa ser criada.

properties.timeCreated

string (date-time)

Obtém o tempo de criação do ponto de restauração.

systemData

systemData

Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

RestorePointCollection

Crie ou atualize os parâmetros da coleção Restore Point.

Name Tipo Descrição
id

string

ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

A geolocalização onde o recurso vive

name

string

O nome do recurso

properties.instantAccess

boolean

Esta propriedade determina se o instantâneo de acesso instantâneo está habilitado para pontos de restauração criados sob essa coleção de pontos de restauração para SSD Premium v2 ou disco Ultra. O instantâneo de acesso instantâneo para SSD Premium v2 ou disco Ultra está disponível instantaneamente para restaurar o disco com desempenho de restauração rápido.

properties.provisioningState

string

O estado de provisionamento da coleção de pontos de restauração.

properties.restorePointCollectionId

string

A id exclusiva da coleção de pontos de restauração.

properties.restorePoints

RestorePoint[]

Uma lista contendo todos os pontos de restauração criados sob esta coleção de pontos de restauração.

properties.source

RestorePointCollectionSourceProperties

As propriedades do recurso de origem a partir do qual esta coleção de pontos de restauração é criada.

systemData

systemData

Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.

tags

object

Tags de recursos.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

RestorePointCollectionSourceProperties

As propriedades do recurso de origem a partir do qual esta coleção de pontos de restauração é criada.

Name Tipo Descrição
id

string

ID do recurso de origem usado para criar essa coleção de pontos de restauração

location

string

Local do recurso de origem usado para criar essa coleção de pontos de restauração.

RestorePointEncryption

Configurações de criptografia em repouso para o ponto de restauração do disco. É uma propriedade opcional que pode ser especificada na entrada durante a criação de um ponto de restauração.

Name Tipo Descrição
diskEncryptionSet

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.

type

RestorePointEncryptionType

O tipo de chave usada para criptografar os dados do ponto de restauração do disco.

RestorePointEncryptionType

O tipo de chave usada para criptografar os dados do ponto de restauração do disco.

Valor Descrição
EncryptionAtRestWithPlatformKey

O Ponto de Restauração de Disco é criptografado em repouso com a chave gerenciada pela plataforma.

EncryptionAtRestWithCustomerKey

O Ponto de Restauração de Disco é criptografado em repouso com a chave gerenciada pelo Cliente que pode ser alterada e revogada por um cliente.

EncryptionAtRestWithPlatformAndCustomerKeys

O Ponto de Restauração de Disco é criptografado em repouso com 2 camadas de criptografia. Uma das chaves é gerida pelo Cliente e a outra chave é gerida pela Plataforma.

RestorePointInstanceView

A exibição de instância de um ponto de restauração.

Name Tipo Descrição
diskRestorePoints

DiskRestorePointInstanceView[]

A restauração do disco aponta informações.

statuses

InstanceViewStatus[]

As informações de status do recurso.

RestorePointSourceMetadata

Descreve as propriedades da máquina virtual para a qual o ponto de restauração foi criado. As propriedades fornecidas são um subconjunto e o instantâneo das propriedades gerais da Máquina Virtual capturadas no momento da criação do ponto de restauração.

Name Tipo Descrição
diagnosticsProfile

DiagnosticsProfile

Obtém o perfil de diagnóstico.

hardwareProfile

HardwareProfile

Obtém o perfil de hardware.

hyperVGeneration

HyperVGenerationTypes

HyperVGeneration da VM de origem para a qual o ponto de restauração é capturado.

licenseType

string

Obtém o tipo de licença, que é para trazer seu próprio cenário de licença.

location

string

Local da VM a partir da qual o ponto de restauração foi criado.

osProfile

OSProfile

Obtém o perfil do sistema operacional.

securityProfile

SecurityProfile

Obtém o perfil de segurança.

storageProfile

RestorePointSourceVMStorageProfile

Obtém o perfil de armazenamento.

userData

string

UserData associado à VM de origem para a qual o ponto de restauração é capturado, que é um valor codificado em base 64.

vmId

string

Obtém a ID exclusiva da máquina virtual.

RestorePointSourceVMDataDisk

Descreve um disco de dados.

Name Tipo Descrição
caching

CachingTypes

Obtém o tipo de cache.

diskRestorePoint

DiskRestorePointAttributes

Contém propriedades do Ponto de Restauração de Disco.

diskSizeGB

integer (int32)

Obtém o tamanho inicial do disco em GB para discos de dados em branco e o novo tamanho desejado para discos de SO e de dados existentes.

lun

integer (int32)

Obtém o número da unidade lógica.

managedDisk

ManagedDiskParameters

Contém os detalhes do disco gerenciado.

name

string

Obtém o nome do disco.

writeAcceleratorEnabled

boolean

Mostra true se o disco estiver habilitado para acelerador de gravação.

RestorePointSourceVMOSDisk

Descreve um disco do sistema operacional.

Name Tipo Descrição
caching

CachingTypes

Obtém o tipo de cache.

diskRestorePoint

DiskRestorePointAttributes

Contém propriedades do Ponto de Restauração de Disco.

diskSizeGB

integer (int32)

Obtém o tamanho do disco em GB.

encryptionSettings

DiskEncryptionSettings

Obtém as configurações de criptografia de disco.

managedDisk

ManagedDiskParameters

Obtém os detalhes do disco gerenciado

name

string

Obtém o nome do disco.

osType

OperatingSystemType

Obtém o tipo de sistema operacional.

writeAcceleratorEnabled

boolean

Mostra true se o disco estiver habilitado para acelerador de gravação.

RestorePointSourceVMStorageProfile

Descreve o perfil de armazenamento.

Name Tipo Descrição
dataDisks

RestorePointSourceVMDataDisk[]

Obtém os discos de dados da VM capturados no momento da criação do ponto de restauração.

diskControllerType

DiskControllerTypes

Obtém o tipo de controlador de disco da VM capturada no momento da criação do ponto de restauração.

osDisk

RestorePointSourceVMOSDisk

Obtém o disco do sistema operacional da VM capturado no momento da criação do ponto de restauração.

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

SecurityProfile

Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento da máquina virtual.

Name Tipo Descrição
encryptionAtHost

boolean

Essa propriedade pode ser usada pelo usuário na solicitação para habilitar ou desabilitar a Criptografia de Host para a máquina virtual ou o conjunto de dimensionamento de máquina virtual. Isso habilitará a criptografia para todos os discos, incluindo o disco Resource/Temp no próprio host. O comportamento padrão é: A criptografia no host será desabilitada, a menos que essa propriedade seja definida como true para o recurso.

encryptionIdentity

EncryptionIdentity

Especifica a Identidade Gerenciada usada pelo ADE para obter o token de acesso para operações keyvault.

proxyAgentSettings

ProxyAgentSettings

Especifica as configurações do ProxyAgent ao criar a máquina virtual. Versão mínima da api: 2023-09-01.

securityType

SecurityTypes

Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings. O comportamento padrão é: UefiSettings não estará ativado a menos que esta propriedade esteja definida e não seja Standard. Se não for especificado, o Standard será devolvido a partir da versão da API 2025-11-01.

uefiSettings

UefiSettings

Especifica as configurações de segurança, como inicialização segura e vTPM, usadas durante a criação da máquina virtual. Versão api mínima: 2020-12-01.

SecurityTypes

Especifica o tipo de segurança da VM; As UefiSettings só estão ativadas quando definidas para TrustedLaunch ou ConfidentialVM, e retornam um valor Standard a partir da versão da API a partir de 2025-11-01.

Valor Descrição
Standard

Indica uma VM sem funcionalidades UEFI como SecureBoot ou vTPM; retornado como valor predefinido quando o TypeSecurityType não é especificado.

TrustedLaunch
ConfidentialVM

SettingNames

Especifica o nome da configuração à qual o conteúdo se aplica. Os valores possíveis são: FirstLogonCommands e AutoLogon.

Valor Descrição
AutoLogon
FirstLogonCommands

SnapshotAccessState

O estado do snapshot que determina a disponibilidade de acesso do snapshot.

Valor Descrição
Unknown

Valor padrão.

Pending

O snapshot não pode ser usado para restaurar, copiar ou baixar para offline.

Available

O instantâneo pode ser usado para restaurar, copiar para região diferente e fazer download para offline.

InstantAccess

O snapshot pode ser usado para restaurar discos com desempenho rápido, mas não pode ser copiado ou baixado.

AvailableWithInstantAccess

O snapshot pode ser usado para restaurar discos com desempenho rápido, copiados e baixados.

SshConfiguration

Configuração SSH para VMs baseadas em Linux em execução no Azure

Name Tipo Descrição
publicKeys

SshPublicKey[]

A lista de chaves públicas SSH usadas para autenticar com VMs baseadas em linux.

SshPublicKey

Contém informações sobre a chave pública do certificado SSH e o caminho na VM Linux onde a chave pública é colocada.

Name Tipo Descrição
keyData

string

Certificado de chave pública SSH usado para autenticar com a VM através do ssh. A chave precisa ser de pelo menos 2048 bits e no formato ssh-rsa. Para criar chaves ssh, consulte [Criar chaves SSH no Linux e Mac para VMs Linux no Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).

path

string

Especifica o caminho completo na VM criada onde a chave pública ssh é armazenada. Se o arquivo já existir, a chave especificada será anexada ao arquivo. Exemplo: /home/user/.ssh/authorized_keys

StatusLevelTypes

O código de nível.

Valor Descrição
Info
Warning
Error

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

SubResource

Name Tipo Descrição
id

string

ID do recurso

systemData

Metadados referentes à criação e última modificação do recurso.

Name Tipo Descrição
createdAt

string (date-time)

A marca temporal da criação do recurso (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string (date-time)

A data e hora da última modificação do recurso (UTC)

lastModifiedBy

string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

UefiSettings

Especifica as configurações de segurança, como inicialização segura e vTPM, usadas durante a criação da máquina virtual. Versão api mínima: 2020-12-01.

Name Tipo Descrição
secureBootEnabled

boolean

Especifica se a inicialização segura deve ser habilitada na máquina virtual. Versão api mínima: 2020-12-01.

vTpmEnabled

boolean

Especifica se o vTPM deve ser habilitado na máquina virtual. Versão api mínima: 2020-12-01.

VaultCertificate

Descreve uma única referência de certificado em um Cofre de Chaves e onde o certificado deve residir na VM.

Name Tipo Descrição
certificateStore

string

Para VMs do Windows, especifica o armazenamento de certificados na Máquina Virtual ao qual o certificado deve ser adicionado. O armazenamento de certificados especificado está implicitamente na conta LocalMachine. Para VMs Linux, o arquivo de certificado é colocado no diretório /var/lib/waagent, com o nome do arquivo <UppercaseThumbprint>.crt para o arquivo de certificado X509 e <UppercaseThumbprint>.prv para chave privada. Ambos os arquivos são .pem formatado.

certificateUrl

string

Este é o URL de um certificado que foi carregado para o Cofre da Chave como um segredo. Para adicionar um segredo ao Cofre de Chaves, consulte Adicionar uma chave ou segredo ao Cofre de Chaves. Nesse caso, seu certificado precisa ser É a codificação Base64 do seguinte objeto JSON que é codificado em UTF-8:

{
"data":"<certificado codificado em Base64>",
"dataType":"pfx",
"senha":"<pfx-file-password>"
}
Para instalar certificados em uma máquina virtual, é recomendável usar a extensão de máquina virtual do Azure Key Vault para Linux ou a extensão de máquina virtual do Azure Key Vault para Windows.

VaultSecretGroup

Descreve um conjunto de certificados que estão todos no mesmo Cofre de Chaves.

Name Tipo Descrição
sourceVault

SubResource

A URL relativa do Cofre da Chave que contém todos os certificados em VaultCertificates.

vaultCertificates

VaultCertificate[]

A lista de referências do cofre de chaves no SourceVault que contêm certificados.

VirtualMachineSizeTypes

Especifica o tamanho da máquina virtual. O tipo de dados enum está atualmente preterido e será removido até 23 de dezembro de 2023. A maneira recomendada de obter a lista de tamanhos disponíveis é usando estas APIs: Listar todos os tamanhos de máquina virtual disponíveis em um conjunto de disponibilidade, Listar todos os tamanhos de máquina virtual disponíveis em uma regiãoListar todos os tamanhos de máquina virtual disponíveis para redimensionamento. Para obter mais informações sobre tamanhos de máquinas virtuais, consulte tamanhos para máquinas virtuais. Os tamanhos de VM disponíveis dependem da região e do conjunto de disponibilidade.

Valor Descrição
Basic_A0
Basic_A1
Basic_A2
Basic_A3
Basic_A4
Standard_A0
Standard_A1
Standard_A2
Standard_A3
Standard_A4
Standard_A5
Standard_A6
Standard_A7
Standard_A8
Standard_A9
Standard_A10
Standard_A11
Standard_A1_v2
Standard_A2_v2
Standard_A4_v2
Standard_A8_v2
Standard_A2m_v2
Standard_A4m_v2
Standard_A8m_v2
Standard_B1s
Standard_B1ms
Standard_B2s
Standard_B2ms
Standard_B4ms
Standard_B8ms
Standard_D1
Standard_D2
Standard_D3
Standard_D4
Standard_D11
Standard_D12
Standard_D13
Standard_D14
Standard_D1_v2
Standard_D2_v2
Standard_D3_v2
Standard_D4_v2
Standard_D5_v2
Standard_D2_v3
Standard_D4_v3
Standard_D8_v3
Standard_D16_v3
Standard_D32_v3
Standard_D64_v3
Standard_D2s_v3
Standard_D4s_v3
Standard_D8s_v3
Standard_D16s_v3
Standard_D32s_v3
Standard_D64s_v3
Standard_D11_v2
Standard_D12_v2
Standard_D13_v2
Standard_D14_v2
Standard_D15_v2
Standard_DS1
Standard_DS2
Standard_DS3
Standard_DS4
Standard_DS11
Standard_DS12
Standard_DS13
Standard_DS14
Standard_DS1_v2
Standard_DS2_v2
Standard_DS3_v2
Standard_DS4_v2
Standard_DS5_v2
Standard_DS11_v2
Standard_DS12_v2
Standard_DS13_v2
Standard_DS14_v2
Standard_DS15_v2
Standard_DS13-4_v2
Standard_DS13-2_v2
Standard_DS14-8_v2
Standard_DS14-4_v2
Standard_E2_v3
Standard_E4_v3
Standard_E8_v3
Standard_E16_v3
Standard_E32_v3
Standard_E64_v3
Standard_E2s_v3
Standard_E4s_v3
Standard_E8s_v3
Standard_E16s_v3
Standard_E32s_v3
Standard_E64s_v3
Standard_E32-16_v3
Standard_E32-8s_v3
Standard_E64-32s_v3
Standard_E64-16s_v3
Standard_F1
Standard_F2
Standard_F4
Standard_F8
Standard_F16
Standard_F1s
Standard_F2s
Standard_F4s
Standard_F8s
Standard_F16s
Standard_F2s_v2
Standard_F4s_v2
Standard_F8s_v2
Standard_F16s_v2
Standard_F32s_v2
Standard_F64s_v2
Standard_F72s_v2
Standard_G1
Standard_G2
Standard_G3
Standard_G4
Standard_G5
Standard_GS1
Standard_GS2
Standard_GS3
Standard_GS4
Standard_GS5
Standard_GS4-8
Standard_GS4-4
Standard_GS5-16
Standard_GS5-8
Standard_H8
Standard_H16
Standard_H8m
Standard_H16m
Standard_H16r
Standard_H16mr
Standard_L4s
Standard_L8s
Standard_L16s
Standard_L32s
Standard_M64s
Standard_M64ms
Standard_M128s
Standard_M128ms
Standard_M64-32ms
Standard_M64-16ms
Standard_M128-64ms
Standard_M128-32ms
Standard_NC6
Standard_NC12
Standard_NC24
Standard_NC24r
Standard_NC6s_v2
Standard_NC12s_v2
Standard_NC24s_v2
Standard_NC24rs_v2
Standard_NC6s_v3
Standard_NC12s_v3
Standard_NC24s_v3
Standard_NC24rs_v3
Standard_ND6s
Standard_ND12s
Standard_ND24s
Standard_ND24rs
Standard_NV6
Standard_NV12
Standard_NV24

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.

VMSizeProperties

Especifica as configurações da Propriedade de Tamanho da VM na máquina virtual.

Name Tipo Descrição
vCPUsAvailable

integer (int32)

Especifica o número de vCPUs disponíveis para a VM. Quando essa propriedade não é especificada no corpo da solicitação, o comportamento padrão é defini-la com o valor de vCPUs disponíveis para esse tamanho de VM exposto na resposta da api de Listar todos os tamanhos de máquina virtual disponíveis em uma região.

vCPUsPerCore

integer (int32)

Especifica a relação vCPU para núcleo físico. Quando essa propriedade não é especificada no corpo da solicitação, o comportamento padrão é definido como o valor de vCPUsPerCore para o Tamanho da VM exposto na resposta da api de Listar todos os tamanhos de máquina virtual disponíveis em uma região. Definir essa propriedade como 1 também significa que o hyper-threading está desabilitado.

WindowsConfiguration

Especifica as configurações do sistema operacional Windows na máquina virtual.

Name Tipo Descrição
additionalUnattendContent

AdditionalUnattendContent[]

Especifica informações adicionais formatadas em XML codificadas em base 64 que podem ser incluídas no arquivo Unattend.xml, que é usado pela Instalação do Windows.

enableAutomaticUpdates

boolean

Indica se as Atualizações Automáticas estão habilitadas para a máquina virtual do Windows. O valor predefinido é verdadeiro. Para conjuntos de dimensionamento de máquina virtual, essa propriedade pode ser atualizada e as atualizações entrarão em vigor no reprovisionamento do sistema operacional.

enableVMAgentPlatformUpdates

boolean

Indica se as Atualizações da Plataforma VMAgent estão habilitadas para a Máquina Virtual do Windows.

patchSettings

PatchSettings

[Funcionalidade de pré-visualização] Especifica as configurações relacionadas ao patch de convidado de VM no Windows.

provisionVMAgent

boolean

Indica se o agente de máquina virtual deve ser provisionado na máquina virtual. Quando essa propriedade não é especificada no corpo da solicitação, ela é definida como true por padrão. Isso garantirá que o Agente de VM seja instalado na VM para que as extensões possam ser adicionadas à VM posteriormente.

timeZone

string

Especifica o fuso horário da máquina virtual. por exemplo, "Hora Padrão do Pacífico". Os valores possíveis podem ser TimeZoneInfo.Id valor de fusos horários retornados por TimeZoneInfo.GetSystemTimeZones.

winRM

WinRMConfiguration

Especifica os ouvintes do Gerenciamento Remoto do Windows. Isso habilita o Windows PowerShell remoto.

WindowsPatchAssessmentMode

Especifica o modo de avaliação de patch do convidado da VM para a máquina virtual IaaS.

Os valores possíveis são:

ImageDefault - Você controla o tempo das avaliações de patch em uma máquina virtual.

AutomaticByPlatform - A plataforma acionará avaliações periódicas de patches. A provisão de propriedadeVMAgent deve ser true.

Valor Descrição
ImageDefault
AutomaticByPlatform

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Especifica a configuração de reinicialização para todas as operações de instalação do patch AutomaticByPlatform.

Valor Descrição
Unknown
IfRequired
Never
Always

WindowsVMGuestPatchAutomaticByPlatformSettings

Especifica configurações adicionais a serem aplicadas quando o modo de patch AutomaticByPlatform é selecionado nas configurações de patch do Windows.

Name Tipo Descrição
bypassPlatformSafetyChecksOnUserSchedule

boolean

Permite que o cliente agende patches sem atualizações acidentais

rebootSetting

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Especifica a configuração de reinicialização para todas as operações de instalação do patch AutomaticByPlatform.

WindowsVMGuestPatchMode

Especifica o modo de aplicação de patches de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquina virtual com OrchestrationMode como flexível.

Os valores possíveis são:

Manual - Você controla a aplicação de patches em uma máquina virtual. Para fazer isso, aplique patches manualmente dentro da VM. Neste modo, as atualizações automáticas são desativadas; a propriedade WindowsConfiguration.enableAutomaticUpdates deve ser false

AutomaticByOS - A máquina virtual será atualizada automaticamente pelo SO. A propriedade WindowsConfiguration.enableAutomaticUpdates deve ser true.

AutomaticByPlatform - a máquina virtual será atualizada automaticamente pela plataforma. As propriedades provisionVMAgent e WindowsConfiguration.enableAutomaticUpdates devem ser true

Valor Descrição
Manual
AutomaticByOS
AutomaticByPlatform

WinRMConfiguration

Descreve a configuração do Gerenciamento Remoto do Windows da VM

Name Tipo Descrição
listeners

WinRMListener[]

A lista de ouvintes do Gerenciamento Remoto do Windows

WinRMListener

Descreve o protocolo e a impressão digital do ouvinte do Gerenciamento Remoto do Windows

Name Tipo Descrição
certificateUrl

string

Este é o URL de um certificado que foi carregado para o Cofre da Chave como um segredo. Para adicionar um segredo ao Cofre de Chaves, consulte Adicionar uma chave ou segredo ao Cofre de Chaves. Nesse caso, seu certificado precisa ser a codificação Base64 do seguinte objeto JSON que é codificado em UTF-8:

{
"data":"<certificado codificado em Base64>",
"dataType":"pfx",
"senha":"<pfx-file-password>"
}
Para instalar certificados em uma máquina virtual, é recomendável usar a extensão de máquina virtual do Azure Key Vault para Linux ou a extensão de máquina virtual do Azure Key Vault para Windows.

protocol

ProtocolTypes

Especifica o protocolo do ouvinte do WinRM. Os valores possíveis são: httphttps.