Partilhar via


Restore Points - Create

A operação para criar o ponto de restauração. Não é permitido atualizar as propriedades de um ponto de restauração existente

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

Parâmetros do URI

Name Em Necessá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. O ID da assinatura faz parte do URI de cada chamada de serviço.

api-version
query True

string

Versão da API do cliente.

Corpo do Pedido

Name 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, 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.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

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

Respostas

Name Tipo Description
201 Created

RestorePoint

Criado

Other Status Codes

CloudError

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

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

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

Copy a restore point to a different region

Pedido de amostra

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

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

Pedido de amostra

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

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

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

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

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, apenas 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 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.

HyperVGenerationTypes

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

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.

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 do passe. Atualmente, o único valor permitido é OobeSystem.

PatchSettings

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

ProtocolTypes

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

ProxyAgentSettings

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

RestorePoint

Detalhes do ponto 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.

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 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 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. NOTA: UltraSSD_LRS só pode ser utilizado com discos de dados, não pode ser utilizado com o OS Disk.

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

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

string

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

ApiError

Erro de api.

Name Tipo Description
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 Description
code

string

O código de erro.

message

string

A mensagem de erro.

target

string

O alvo do erro específico.

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

Name Tipo Description
None

string

ReadOnly

string

ReadWrite

string

CloudError

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

Name Tipo Description
error

ApiError

Erro de api.

ComponentNames

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

Name Tipo Description
Microsoft-Windows-Shell-Setup

string

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.

Name Tipo Description
ApplicationConsistent

string

CrashConsistent

string

FileSystemConsistent

string

DiagnosticsProfile

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

Name Tipo Description
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.

DiskControllerTypes

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

Name Tipo Description
NVMe

string

SCSI

string

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

string

ID do recurso

DiskEncryptionSettings

Descreve uma configuração de criptografia para um disco

Name Tipo Description
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 Description
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 Description
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.

DiskRestorePointReplicationStatus

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

Name Tipo Description
completionPercent

integer

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

HyperVGenerationTypes

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

Name Tipo Description
V1

string

V2

string

InnerError

Detalhes do erro interno.

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

A hora do status.

KeyVaultKeyReference

Descreve uma referência à chave do cofre da chave

Name Tipo Description
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 Description
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 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 é false.

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.

Name Tipo Description
AutomaticByPlatform

string

ImageDefault

string

LinuxPatchSettings

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

Name Tipo Description
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.

Name Tipo Description
Always

string

IfRequired

string

Never

string

Unknown

string

LinuxVMGuestPatchAutomaticByPlatformSettings

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

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

Name Tipo Description
AutomaticByPlatform

string

ImageDefault

string

ManagedDiskParameters

Os parâmetros de um disco gerenciado.

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

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.

Name Tipo Description
Audit

string

Enforce

string

OperatingSystemType

Obtém o tipo de sistema operacional.

Name Tipo Description
Linux

string

Windows

string

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

string

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

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

Name Tipo Description
OobeSystem

string

PatchSettings

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

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

ProtocolTypes

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

Name Tipo Description
Http

string

Https

string

ProxyAgentSettings

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

Name Tipo Description
enabled

boolean

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

keyIncarnationId

integer

Aumentar o valor dessa propriedade permite que o usuário 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 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.

RestorePoint

Detalhes do ponto de restauração.

Name 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, 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.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

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

type

string

Tipo de recurso

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

Name Tipo Description
EncryptionAtRestWithCustomerKey

string

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

string

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.

EncryptionAtRestWithPlatformKey

string

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

RestorePointInstanceView

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

Name Tipo Description
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 Description
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 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 SO e de dados 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

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

RestorePointSourceVMOSDisk

Descreve um disco do sistema operacional.

Name 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

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

RestorePointSourceVMStorageProfile

Descreve o perfil de armazenamento.

Name Tipo Description
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.

Name Tipo Description
DiskWithVMGuestState

string

NonPersistedTPM

string

VMGuestStateOnly

string

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 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á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 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 api mínima: 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.

Name Tipo Description
ConfidentialVM

string

TrustedLaunch

string

SettingNames

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

Name Tipo Description
AutoLogon

string

FirstLogonCommands

string

SshConfiguration

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

Name 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 Linux onde a chave pública é colocada.

Name Tipo Description
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.

Name Tipo Description
Error

string

Info

string

Warning

string

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.

Name Tipo Description
PremiumV2_LRS

string

Premium_LRS

string

Premium_ZRS

string

StandardSSD_LRS

string

StandardSSD_ZRS

string

Standard_LRS

string

UltraSSD_LRS

string

SubResource

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

Name Tipo Description
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 Description
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:

{
"dados":"",
"dataType":"pfx",
"senha":""
}
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 Description
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.

Name Tipo Description
Basic_A0

string

Basic_A1

string

Basic_A2

string

Basic_A3

string

Basic_A4

string

Standard_A0

string

Standard_A1

string

Standard_A10

string

Standard_A11

string

Standard_A1_v2

string

Standard_A2

string

Standard_A2_v2

string

Standard_A2m_v2

string

Standard_A3

string

Standard_A4

string

Standard_A4_v2

string

Standard_A4m_v2

string

Standard_A5

string

Standard_A6

string

Standard_A7

string

Standard_A8

string

Standard_A8_v2

string

Standard_A8m_v2

string

Standard_A9

string

Standard_B1ms

string

Standard_B1s

string

Standard_B2ms

string

Standard_B2s

string

Standard_B4ms

string

Standard_B8ms

string

Standard_D1

string

Standard_D11

string

Standard_D11_v2

string

Standard_D12

string

Standard_D12_v2

string

Standard_D13

string

Standard_D13_v2

string

Standard_D14

string

Standard_D14_v2

string

Standard_D15_v2

string

Standard_D16_v3

string

Standard_D16s_v3

string

Standard_D1_v2

string

Standard_D2

string

Standard_D2_v2

string

Standard_D2_v3

string

Standard_D2s_v3

string

Standard_D3

string

Standard_D32_v3

string

Standard_D32s_v3

string

Standard_D3_v2

string

Standard_D4

string

Standard_D4_v2

string

Standard_D4_v3

string

Standard_D4s_v3

string

Standard_D5_v2

string

Standard_D64_v3

string

Standard_D64s_v3

string

Standard_D8_v3

string

Standard_D8s_v3

string

Standard_DS1

string

Standard_DS11

string

Standard_DS11_v2

string

Standard_DS12

string

Standard_DS12_v2

string

Standard_DS13

string

Standard_DS13-2_v2

string

Standard_DS13-4_v2

string

Standard_DS13_v2

string

Standard_DS14

string

Standard_DS14-4_v2

string

Standard_DS14-8_v2

string

Standard_DS14_v2

string

Standard_DS15_v2

string

Standard_DS1_v2

string

Standard_DS2

string

Standard_DS2_v2

string

Standard_DS3

string

Standard_DS3_v2

string

Standard_DS4

string

Standard_DS4_v2

string

Standard_DS5_v2

string

Standard_E16_v3

string

Standard_E16s_v3

string

Standard_E2_v3

string

Standard_E2s_v3

string

Standard_E32-16_v3

string

Standard_E32-8s_v3

string

Standard_E32_v3

string

Standard_E32s_v3

string

Standard_E4_v3

string

Standard_E4s_v3

string

Standard_E64-16s_v3

string

Standard_E64-32s_v3

string

Standard_E64_v3

string

Standard_E64s_v3

string

Standard_E8_v3

string

Standard_E8s_v3

string

Standard_F1

string

Standard_F16

string

Standard_F16s

string

Standard_F16s_v2

string

Standard_F1s

string

Standard_F2

string

Standard_F2s

string

Standard_F2s_v2

string

Standard_F32s_v2

string

Standard_F4

string

Standard_F4s

string

Standard_F4s_v2

string

Standard_F64s_v2

string

Standard_F72s_v2

string

Standard_F8

string

Standard_F8s

string

Standard_F8s_v2

string

Standard_G1

string

Standard_G2

string

Standard_G3

string

Standard_G4

string

Standard_G5

string

Standard_GS1

string

Standard_GS2

string

Standard_GS3

string

Standard_GS4

string

Standard_GS4-4

string

Standard_GS4-8

string

Standard_GS5

string

Standard_GS5-16

string

Standard_GS5-8

string

Standard_H16

string

Standard_H16m

string

Standard_H16mr

string

Standard_H16r

string

Standard_H8

string

Standard_H8m

string

Standard_L16s

string

Standard_L32s

string

Standard_L4s

string

Standard_L8s

string

Standard_M128-32ms

string

Standard_M128-64ms

string

Standard_M128ms

string

Standard_M128s

string

Standard_M64-16ms

string

Standard_M64-32ms

string

Standard_M64ms

string

Standard_M64s

string

Standard_NC12

string

Standard_NC12s_v2

string

Standard_NC12s_v3

string

Standard_NC24

string

Standard_NC24r

string

Standard_NC24rs_v2

string

Standard_NC24rs_v3

string

Standard_NC24s_v2

string

Standard_NC24s_v3

string

Standard_NC6

string

Standard_NC6s_v2

string

Standard_NC6s_v3

string

Standard_ND12s

string

Standard_ND24rs

string

Standard_ND24s

string

Standard_ND6s

string

Standard_NV12

string

Standard_NV24

string

Standard_NV6

string

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

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 Description
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 padrão é true. 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.

Name Tipo Description
AutomaticByPlatform

string

ImageDefault

string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

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

Name Tipo Description
Always

string

IfRequired

string

Never

string

Unknown

string

WindowsVMGuestPatchAutomaticByPlatformSettings

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

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

Name Tipo Description
AutomaticByOS

string

AutomaticByPlatform

string

Manual

string

WinRMConfiguration

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

Name Tipo Description
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 Description
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:

{
"dados":"",
"dataType":"pfx",
"senha":""
}
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.