Compartilhar via


Restore Points - Create

A operação para criar o ponto de restauração. A atualização de propriedades de um ponto de restauração existente não é permitida

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}?api-version=2024-07-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos.

restorePointCollectionName
path True

string

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

restorePointName
path True

string

O nome do ponto de restauração.

subscriptionId
path True

string

Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.

api-version
query True

string

Versão da API do cliente.

Corpo da solicitação

Nome Tipo Description
properties.consistencyMode

ConsistencyModeTypes

ConsistencyMode do RestorePoint. Pode ser especificado na entrada durante a criação de um ponto de restauração. Por enquanto, somente 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.sourceMetadata

RestorePointSourceMetadata

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

properties.sourceRestorePoint

ApiEntityReference

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

properties.timeCreated

string

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

Respostas

Nome Tipo Description
201 Created

RestorePoint

Criado

Other Status Codes

CloudError

Resposta de erro que descreve por que a operação falhou.

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

Copy a restore point to a different region
Create a restore point

Copy a restore point to a different region

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName?api-version=2024-07-01

{
  "properties": {
    "sourceRestorePoint": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName/restorePoints/sourceRpName"
    }
  }
}

Resposta de exemplo

{
  "name": "rpName",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName",
  "properties": {
    "sourceRestorePoint": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName/restorePoints/sourceRpName"
    },
    "sourceMetadata": {
      "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
      "hardwareProfile": {
        "vmSize": "Standard_B1s"
      },
      "storageProfile": {
        "osDisk": {
          "osType": "Windows",
          "name": "osDisk123",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/osDisk123"
          },
          "diskRestorePoint": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/osDisk123_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
          }
        },
        "dataDisks": [
          {
            "lun": 1,
            "name": "dataDisk123",
            "caching": "None",
            "managedDisk": {
              "storageAccountType": "Standard_LRS",
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/dataDisk123"
            },
            "diskRestorePoint": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/dataDisk123_68785190-1acb-4d5e-a8ae-705b45f3dca5"
            }
          }
        ],
        "diskControllerType": "NVMe"
      },
      "osProfile": {
        "computerName": "computerName",
        "adminUsername": "admin",
        "windowsConfiguration": {
          "provisionVMAgent": true,
          "enableAutomaticUpdates": true
        },
        "secrets": [],
        "allowExtensionOperations": true,
        "requireGuestProvisionSignal": true
      },
      "diagnosticsProfile": {
        "bootDiagnostics": {
          "enabled": true
        }
      },
      "location": "westus",
      "userData": "c2FtcGxlIHVzZXJEYXRh"
    },
    "provisioningState": "Creating",
    "consistencyMode": "ApplicationConsistent",
    "timeCreated": "2021-10-25T23:54:29.2796325+00:00"
  }
}

Create a restore point

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName?api-version=2024-07-01

{
  "properties": {
    "excludeDisks": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
      }
    ]
  }
}

Resposta de exemplo

{
  "name": "rpName",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName",
  "properties": {
    "excludeDisks": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
      }
    ],
    "sourceMetadata": {
      "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
      "hardwareProfile": {
        "vmSize": "Standard_B1s"
      },
      "storageProfile": {
        "osDisk": {
          "osType": "Windows",
          "name": "osDisk123",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/osDisk123"
          },
          "diskRestorePoint": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/osDisk123_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
          }
        },
        "dataDisks": [
          {
            "lun": 1,
            "name": "dataDisk123",
            "caching": "None",
            "managedDisk": {
              "storageAccountType": "Standard_LRS",
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/dataDisk123"
            },
            "diskRestorePoint": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/dataDisk123_68785190-1acb-4d5e-a8ae-705b45f3dca5"
            }
          }
        ],
        "diskControllerType": "NVMe"
      },
      "osProfile": {
        "computerName": "computerName",
        "adminUsername": "admin",
        "windowsConfiguration": {
          "provisionVMAgent": true,
          "enableAutomaticUpdates": true
        },
        "secrets": [],
        "allowExtensionOperations": true,
        "requireGuestProvisionSignal": true
      },
      "diagnosticsProfile": {
        "bootDiagnostics": {
          "enabled": true
        }
      },
      "location": "westus",
      "userData": "c2FtcGxlIHVzZXJEYXRh"
    },
    "provisioningState": "Succeeded",
    "consistencyMode": "ApplicationConsistent",
    "timeCreated": "2021-01-27T20:35:05.8401519+00:00"
  }
}

Definições

Nome Description
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 pelo nome da configuração, pelo nome do componente e pela passagem na qual o conteúdo é aplicado.

ApiEntityReference

A referência da entidade de API.

ApiError

Erro de API.

ApiErrorBase

Base de erros de API.

BootDiagnostics

O Diagnóstico de Inicialização é um recurso de depuração que permite exibir a Saída do Console e a Captura de Tela para diagnosticar o status da VM. Você pode exibir 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

Obtém o tipo de cache.

CloudError

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

ComponentNames

O nome do componente. Atualmente, o único valor permitido é 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, somente CrashConsistent é aceito como uma entrada válida. Consulte https://aka.ms/RestorePoints para obter mais detalhes.

DiagnosticsProfile

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

DiskControllerTypes

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

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 uma configuração de criptografia para um disco

DiskRestorePointAttributes

Detalhes do Ponto de Restauração de 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 de keyvault.

HardwareProfile

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

HyperVGenerationTypes

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

InnerError

Detalhes do erro interno.

InstanceViewStatus

Status da exibição da instância.

KeyVaultKeyReference

Descreve uma referência à Chave do Key Vault

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 do Linux com suporte, consulte Linux nodistribuições de Azure-Endorsed.

LinuxPatchAssessmentMode

Especifica o modo de Avaliação de Patch 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 disparará avaliações periódicas de patch. A propriedade provisionVMAgent deve ser verdadeira.

LinuxPatchSettings

Especifica as configurações relacionadas à aplicação de patch de convidado da VM no Linux.

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Especifica a configuração de reinicialização para todas as operações de instalação de 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 patch de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquinas virtuais com OrchestrationMode como Flexível.

Os valores possíveis são:

ImageDefault – a configuração de aplicação de patch padrão da máquina virtual é usada.

AutomaticByPlatform – a máquina virtual será atualizada automaticamente pela plataforma. A propriedade provisionVMAgent deve ser verdadeira

ManagedDiskParameters

Os parâmetros de um disco gerenciado.

Mode

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

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

O nome da passagem. Atualmente, o único valor permitido é OobeSystem.

PatchSettings

Especifica as configurações relacionadas à aplicação de patch de convidado da VM no Windows.

ProtocolTypes

Especifica o protocolo do ouvinte WinRM. Os valores possíveis são: http,https.

ProxyAgentSettings

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

RestorePoint

Detalhes do Ponto de Restauração.

RestorePointEncryption

Criptografia em configurações de repouso para o ponto de restauração de 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 usado para criptografar os dados do ponto de restauração de 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 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.

SecurityProfile

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

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 será habilitado, a menos que essa propriedade esteja definida.

SettingNames

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

SshConfiguration

Configuração de 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 do Linux em que a chave pública é colocada.

StatusLevelTypes

O código de nível.

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.

SubResource
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 mínima da API: 2020-12-01.

VaultCertificate

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

VaultSecretGroup

Descreve um conjunto de certificados que estão todos no mesmo Key Vault.

VirtualMachineSizeTypes

Especifica o tamanho da máquina virtual. O tipo de dados de enumeração foi preterido no momento e será removido até 23 de dezembro de 2023. A maneira recomendada de obter a lista de tamanhos disponíveis é usar essas 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ão, Listar todos os tamanhos de máquina virtual disponíveis para redimensionar. Para obter mais informações sobre tamanhos de máquina virtual, consulte Sizes for virtual machines. 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. Observação: Ele só pode ser definido para VMs confidenciais.

VMSizeProperties

Especifica as configurações da Propriedade 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 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 disparará avaliações periódicas de patch. A propriedade provisionVMAgent deve ser verdadeira.

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Especifica a configuração de reinicialização para todas as operações de instalação de 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 patch de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquinas virtuais com OrchestrationMode como Flexível.

Os valores possíveis são:

manual – você controla a aplicação de patches em uma máquina virtual. Faça isso aplicando patches manualmente dentro da VM. Nesse modo, as atualizações automáticas são desabilitadas; a propriedade WindowsConfiguration.enableAutomaticUpdates deve ser falsa

AutomaticByOS – a máquina virtual será atualizada automaticamente pelo sistema operacional. A propriedade WindowsConfiguration.enableAutomaticUpdates deve ser verdadeira.

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

WinRMConfiguration

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

WinRMListener

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

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 pelo nome da configuração, pelo nome do componente e pela passagem na qual o conteúdo é aplicado.

Nome Tipo Description
componentName

ComponentNames

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

content

string

Especifica o conteúdo formatado XML que é adicionado ao arquivo 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 o recurso que está sendo inserido.

passName

PassNames

O nome da passagem. 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 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 de 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.

BootDiagnostics

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

Nome Tipo Description
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

Obtém o tipo de cache.

Valor Description
None
ReadOnly
ReadWrite

CloudError

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

Nome Tipo Description
error

ApiError

Erro de API.

ComponentNames

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

Valor Description
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, somente CrashConsistent é aceito como uma entrada válida. Consulte https://aka.ms/RestorePoints para obter mais detalhes.

Valor Description
ApplicationConsistent
CrashConsistent
FileSystemConsistent

DiagnosticsProfile

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

Nome Tipo Description
bootDiagnostics

BootDiagnostics

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

DiskControllerTypes

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

Valor Description
NVMe
SCSI

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 uma configuração de criptografia para 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.

DiskRestorePointAttributes

Detalhes do Ponto de Restauração de Disco.

Nome Tipo Description
encryption

RestorePointEncryption

Criptografia em configurações de repouso para o ponto de restauração de 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.

Nome Tipo Description
id

string

ID do ponto de restauração de disco.

replicationStatus

DiskRestorePointReplicationStatus

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

DiskRestorePointReplicationStatus

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

Nome Tipo Description
completionPercent

integer

Percentual 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 de keyvault.

Nome Tipo Description
userAssignedIdentityResourceId

string

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

HardwareProfile

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

Nome Tipo Description
vmSize

VirtualMachineSizeTypes

Especifica o tamanho da máquina virtual. O tipo de dados de enumeração foi preterido no momento e será removido até 23 de dezembro de 2023. A maneira recomendada de obter a lista de tamanhos disponíveis é usar essas 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ão, Listar todos os tamanhos de máquina virtual disponíveis para redimensionar. Para obter mais informações sobre tamanhos de máquina virtual, consulte Sizes for virtual machines. 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 da API: 2021-07-01. Esse recurso ainda está no modo de visualização e não tem suporte para VirtualMachineScaleSet. Siga as instruções em de Personalização de VM para obter mais detalhes.

HyperVGenerationTypes

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

Valor Description
V1
V2

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.

InstanceViewStatus

Status da exibição da instância.

Nome Tipo Description
code

string

O código de status.

displayStatus

string

O rótulo localizável curto 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

A hora do status.

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.

LinuxConfiguration

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

Nome Tipo Description
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 padrão é falso.

patchSettings

LinuxPatchSettings

[Recurso de visualização] Especifica as configurações relacionadas à aplicação de patch de convidado da 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 de chave ssh para um sistema operacional Linux.

LinuxPatchAssessmentMode

Especifica o modo de Avaliação de Patch 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 disparará avaliações periódicas de patch. A propriedade provisionVMAgent deve ser verdadeira.

Valor Description
AutomaticByPlatform
ImageDefault

LinuxPatchSettings

Especifica as configurações relacionadas à aplicação de patch de convidado da VM no Linux.

Nome Tipo Description
assessmentMode

LinuxPatchAssessmentMode

Especifica o modo de Avaliação de Patch 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 disparará avaliações periódicas de patch. A propriedade provisionVMAgent deve ser verdadeira.

automaticByPlatformSettings

LinuxVMGuestPatchAutomaticByPlatformSettings

Especifica configurações adicionais para o modo de patch AutomaticByPlatform na Aplicação de Patch de Convidado de VM no Linux.

patchMode

LinuxVMGuestPatchMode

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

Os valores possíveis são:

ImageDefault – a configuração de aplicação de patch padrão da máquina virtual é usada.

AutomaticByPlatform – a máquina virtual será atualizada automaticamente pela plataforma. A propriedade provisionVMAgent deve ser verdadeira

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

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

Valor Description
Always
IfRequired
Never
Unknown

LinuxVMGuestPatchAutomaticByPlatformSettings

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

Nome Tipo Description
bypassPlatformSafetyChecksOnUserSchedule

boolean

Permite que o cliente agende a aplicação de patch sem atualizações acidentais

rebootSetting

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

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

LinuxVMGuestPatchMode

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

Os valores possíveis são:

ImageDefault – a configuração de aplicação de patch padrão da máquina virtual é usada.

AutomaticByPlatform – a máquina virtual será atualizada automaticamente pela plataforma. A propriedade provisionVMAgent deve ser verdadeira

Valor Description
AutomaticByPlatform
ImageDefault

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.

Mode

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

Valor Description
Audit
Enforce

OperatingSystemType

Obtém o tipo de sistema operacional.

Valor Description
Linux
Windows

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.

Nome Tipo Description
adminPassword

string

Especifica a senha da conta de administrador.

Comprimento mínimo (Windows): 8 caracteres

Comprimento mínimo (Linux): 6 caracteres

comprimento máximo (Windows): 123 caracteres

comprimento máximo (Linux): 72 caracteres

requisitos de complexidade: 3 de 4 condições abaixo precisam ser atendidas
Tem caracteres inferiores
Tem caracteres superiores
Tem um dígito
Tem um caractere especial (correspondência regex [\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 logon em uma VM do Windows

Para redefinir a senha raiz, 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 após a criação da VM.

restrição somente do Windows: Não é possível terminar em "".

valores não permitidos: "administrador", "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

comprimento máximo (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ó poderá ser definido como False quando nenhuma extensão estiver presente na máquina virtual.

computerName

string

Especifica o nome do sistema operacional do host da máquina virtual. Esse nome não pode ser atualizado após a criação da VM. tamanho máximo (Windows): 15 caracteres. Comprimento máximo (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 salva como um arquivo na Máquina Virtual. O comprimento máximo da matriz binária é de 65535 bytes. Observação: não passe segredos ou senhas na propriedade customData. Essa propriedade não pode ser atualizada após a criação da VM. A propriedade 'customData' é passada para a VM a ser salva como um arquivo, para obter mais informações, consulte Dados Personalizados em VMs do Azure. Para usar o cloud-init para sua VM linux, consulte Usando cloud-init para personalizar uma VM do 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 do Linux com suporte, consulte Linux nodistribuições de Azure-Endorsed.

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

O nome da passagem. Atualmente, o único valor permitido é OobeSystem.

Valor Description
OobeSystem

PatchSettings

Especifica as configurações relacionadas à aplicação de patch de convidado da VM no Windows.

Nome Tipo Description
assessmentMode

WindowsPatchAssessmentMode

Especifica o modo de avaliação de patch 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 disparará avaliações periódicas de patch. A propriedade provisionVMAgent deve ser verdadeira.

automaticByPlatformSettings

WindowsVMGuestPatchAutomaticByPlatformSettings

Especifica configurações adicionais para o modo de patch AutomaticByPlatform na Aplicação de Patch de Convidado de VM 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 patch de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquinas virtuais com OrchestrationMode como Flexível.

Os valores possíveis são:

manual – você controla a aplicação de patches em uma máquina virtual. Faça isso aplicando patches manualmente dentro da VM. Nesse modo, as atualizações automáticas são desabilitadas; a propriedade WindowsConfiguration.enableAutomaticUpdates deve ser falsa

AutomaticByOS – a máquina virtual será atualizada automaticamente pelo sistema operacional. A propriedade WindowsConfiguration.enableAutomaticUpdates deve ser verdadeira.

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

ProtocolTypes

Especifica o protocolo do ouvinte WinRM. Os valores possíveis são: http,https.

Valor Description
Http
Https

ProxyAgentSettings

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

Nome Tipo Description
enabled

boolean

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

keyIncarnationId

integer

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

mode

Mode

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

RestorePoint

Detalhes do Ponto de Restauração.

Nome Tipo Description
id

string

ID do recurso

name

string

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, somente 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

O modo de exibição da instância do 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 capturada no momento da criação do ponto de restauração.

properties.sourceRestorePoint

ApiEntityReference

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

properties.timeCreated

string

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

type

string

Tipo de recurso

RestorePointEncryption

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

Nome Tipo Description
diskEncryptionSet

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.

type

RestorePointEncryptionType

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

RestorePointEncryptionType

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

Valor Description
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 duas camadas de criptografia. Uma das chaves é gerenciada pelo cliente e a outra chave é gerenciada pela plataforma.

EncryptionAtRestWithPlatformKey

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

RestorePointInstanceView

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

Nome Tipo Description
diskRestorePoints

DiskRestorePointInstanceView[]

As informações de pontos de restauração de disco.

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.

Nome Tipo Description
diagnosticsProfile

DiagnosticsProfile

Obtém o perfil de diagnóstico.

hardwareProfile

HardwareProfile

Obtém o perfil de hardware.

hyperVGeneration

HyperVGenerationTypes

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

Nome Tipo Description
caching

CachingTypes

Obtém o tipo de cache.

diskRestorePoint

DiskRestorePointAttributes

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

diskSizeGB

integer

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

lun

integer

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

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

RestorePointSourceVMOSDisk

Descreve um disco do sistema operacional.

Nome Tipo Description
caching

CachingTypes

Obtém o tipo de cache.

diskRestorePoint

DiskRestorePointAttributes

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

diskSizeGB

integer

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

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

RestorePointSourceVMStorageProfile

Descreve o perfil de armazenamento.

Nome Tipo Description
dataDisks

RestorePointSourceVMDataDisk[]

Obtém os discos de dados da VM capturada 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 capturada 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 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
DiskWithVMGuestState
NonPersistedTPM
VMGuestStateOnly

SecurityProfile

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

Nome Tipo Description
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áquinas virtuais. 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 verdadeira para o recurso.

encryptionIdentity

EncryptionIdentity

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

proxyAgentSettings

ProxyAgentSettings

Especifica as configurações de 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 será habilitado, a menos que essa propriedade esteja definida.

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 mínima da API: 2020-12-01.

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 será habilitado, a menos que essa propriedade esteja definida.

Valor Description
ConfidentialVM
TrustedLaunch

SettingNames

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

Valor Description
AutoLogon
FirstLogonCommands

SshConfiguration

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

Nome Tipo Description
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 do Linux em que a chave pública é colocada.

Nome Tipo Description
keyData

string

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

path

string

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

StatusLevelTypes

O código de nível.

Valor Description
Error
Info
Warning

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.

Valor Description
PremiumV2_LRS
Premium_LRS
Premium_ZRS
StandardSSD_LRS
StandardSSD_ZRS
Standard_LRS
UltraSSD_LRS

SubResource

Nome Tipo Description
id

string

ID 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 mínima da API: 2020-12-01.

Nome Tipo Description
secureBootEnabled

boolean

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

vTpmEnabled

boolean

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

VaultCertificate

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

Nome Tipo Description
certificateStore

string

Para VMs do Windows, especifica o repositório de certificados na Máquina Virtual à qual o certificado deve ser adicionado. O repositório 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 formatados em .pem.

certificateUrl

string

Essa é a URL de um certificado que foi carregado no Key Vault como um segredo. Para adicionar um segredo ao Key Vault, consulte Adicionar uma chave ou segredo ao cofre de chaves. Nesse caso, seu certificado precisa ser a codificação Base64 do seguinte objeto JSON codificado em UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
Para instalar certificados em uma máquina virtual, é recomendável usar a extensão de máquina virtual 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 Key Vault.

Nome Tipo Description
sourceVault

SubResource

A URL relativa do Key Vault 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 de enumeração foi preterido no momento e será removido até 23 de dezembro de 2023. A maneira recomendada de obter a lista de tamanhos disponíveis é usar essas 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ão, Listar todos os tamanhos de máquina virtual disponíveis para redimensionar. Para obter mais informações sobre tamanhos de máquina virtual, consulte Sizes for virtual machines. Os tamanhos de VM disponíveis dependem da região e do conjunto de disponibilidade.

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

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.

VMSizeProperties

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

Nome Tipo Description
vCPUsAvailable

integer

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 para o valor de vCPUs disponíveis para esse tamanho de VM exposto na resposta à API de Listar todos os tamanhos de máquina virtual disponíveis em uma região.

vCPUsPerCore

integer

Especifica a relação vCPU com 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 à 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 hiper-threading está desabilitado.

WindowsConfiguration

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

Nome Tipo Description
additionalUnattendContent

AdditionalUnattendContent[]

Especifica informações XML codificadas em base 64 adicionais 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 padrão é verdadeiro. Para conjuntos de dimensionamento de máquinas virtuais, 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

[Recurso de visualização] Especifica as configurações relacionadas à aplicação de patch de convidado da 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, "Horário 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 de Gerenciamento Remoto do Windows. Isso habilita o Windows PowerShell remoto.

WindowsPatchAssessmentMode

Especifica o modo de avaliação de patch 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 disparará avaliações periódicas de patch. A propriedade provisionVMAgent deve ser verdadeira.

Valor Description
AutomaticByPlatform
ImageDefault

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

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

Valor Description
Always
IfRequired
Never
Unknown

WindowsVMGuestPatchAutomaticByPlatformSettings

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

Nome Tipo Description
bypassPlatformSafetyChecksOnUserSchedule

boolean

Permite que o cliente agende a aplicação de patch sem atualizações acidentais

rebootSetting

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

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

WindowsVMGuestPatchMode

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

Os valores possíveis são:

manual – você controla a aplicação de patches em uma máquina virtual. Faça isso aplicando patches manualmente dentro da VM. Nesse modo, as atualizações automáticas são desabilitadas; a propriedade WindowsConfiguration.enableAutomaticUpdates deve ser falsa

AutomaticByOS – a máquina virtual será atualizada automaticamente pelo sistema operacional. A propriedade WindowsConfiguration.enableAutomaticUpdates deve ser verdadeira.

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

Valor Description
AutomaticByOS
AutomaticByPlatform
Manual

WinRMConfiguration

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

Nome Tipo Description
listeners

WinRMListener[]

A lista de ouvintes de Gerenciamento Remoto do Windows

WinRMListener

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

Nome Tipo Description
certificateUrl

string

Essa é a URL de um certificado que foi carregado no Key Vault como um segredo. Para adicionar um segredo ao Key Vault, consulte Adicionar uma chave ou segredo ao cofre de chaves. Nesse caso, seu certificado precisa ser a codificação Base64 do seguinte objeto JSON codificado em UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
Para instalar certificados em uma máquina virtual, é recomendável usar a extensão de máquina virtual 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 WinRM. Os valores possíveis são: http,https.