Virtual Machine Scale Set VM Extensions - Create Or Update

A operação para criar ou atualizar a extensão VMSS VM.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}?api-version=2026-04-01

Parâmetros do URI

Nome Em Obrigatório Tipo Descrição
instanceId
path True

string

O ID da instância da máquina virtual.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

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

subscriptionId
path True

string

minLength: 1

O ID da assinatura de destino.

vmExtensionName
path True

string

O nome da extensão da máquina virtual.

vmScaleSetName
path True

string

O nome do conjunto de escala de VM.

api-version
query True

string

minLength: 1

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

Corpo do Pedido

Nome Tipo Descrição
location

string

A localização da extensão.

properties.autoUpgradeMinorVersion

boolean

Indica se a extensão deve usar uma versão secundária mais recente, se uma estiver disponível no momento da implantação. Uma vez implantada, no entanto, a extensão não atualizará versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como true.

properties.enableAutomaticUpgrade

boolean

Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente da extensão disponível.

properties.forceUpdateTag

string

Como o manipulador de extensão deve ser forçado a atualizar mesmo que a configuração da extensão não tenha sido alterada.

properties.instanceView

VirtualMachineExtensionInstanceView

A exibição da instância de extensão de máquina virtual.

properties.protectedSettings

A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida.

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

As extensões protegem as configurações que são passadas por referência e consumidas do cofre de chaves

properties.provisionAfterExtensions

string[]

Coleção de nomes de extensão após a qual essa extensão precisa ser provisionada.

properties.publisher

string

O nome do editor do manipulador de extensão.

properties.settings

Json formatou configurações públicas para a extensão.

properties.suppressFailures

boolean

Indica se as falhas decorrentes da extensão serão suprimidas (Falhas operacionais, como não se conectar à VM, não serão suprimidas, independentemente desse valor). O valor predefinido é falso.

properties.type

string

Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".

properties.typeHandlerVersion

string

Especifica a versão Major.Minor do handler de scripts. O cliente pode especificar apenas a versão Major.Minor de uma extensão, enquanto a plataforma Azure fornecerá a versão mais recente do Patch.Hotfix da série Major.Minor.

Respostas

Nome Tipo Descrição
200 OK

VirtualMachineScaleSetVMExtension

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

201 Created

VirtualMachineScaleSetVMExtension

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

Cabeçalhos

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

CloudError

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

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

Exemplos

Create VirtualMachineScaleSet VM extension.

Pedido de amostra

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension?api-version=2026-04-01

{
  "properties": {
    "autoUpgradeMinorVersion": true,
    "publisher": "extPublisher",
    "type": "extType",
    "typeHandlerVersion": "1.2",
    "settings": {
      "UserName": "xyz@microsoft.com"
    }
  }
}

Resposta da amostra

{
  "name": "myVMExtension",
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension",
  "properties": {
    "autoUpgradeMinorVersion": true,
    "provisioningState": "Creating",
    "publisher": "extPublisher",
    "type": "extType",
    "typeHandlerVersion": "1.2",
    "settings": {
      "UserName": "xyz@microsoft.com"
    }
  }
}
{
  "name": "myVMExtension",
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension",
  "properties": {
    "autoUpgradeMinorVersion": true,
    "provisioningState": "Creating",
    "publisher": "extPublisher",
    "type": "extType",
    "typeHandlerVersion": "1.2",
    "settings": {
      "UserName": "xyz@microsoft.com"
    }
  }
}

Definições

Nome Descrição
ApiError

Erro de api.

ApiErrorBase

Base de erro da api.

CloudError

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

InnerError

Detalhes do erro interno.

InstanceViewStatus

Status da exibição da instância.

KeyVaultSecretReference

Descreve uma referência ao segredo do Key Vault

StatusLevelTypes

O código de nível.

SubResource
VirtualMachineExtensionInstanceView

A exibição de instância de uma extensão de máquina virtual.

VirtualMachineScaleSetVMExtension

Descreve uma extensão VMSS VM.

ApiError

Erro de api.

Nome Tipo Descrição
code

string

O código de erro.

details

ApiErrorBase[]

Os detalhes do erro Api

innererror

InnerError

O erro interno da Api

message

string

A mensagem de erro.

target

string

O alvo do erro específico.

ApiErrorBase

Base de erro da api.

Nome Tipo Descrição
code

string

O código de erro.

message

string

A mensagem de erro.

target

string

O alvo do erro específico.

CloudError

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

Nome Tipo Descrição
error

ApiError

Erro de api.

InnerError

Detalhes do erro interno.

Nome Tipo Descrição
errordetail

string

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

exceptiontype

string

O tipo de exceção.

InstanceViewStatus

Status da exibição da instância.

Nome Tipo Descrição
code

string

O código de status.

displayStatus

string

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

level

StatusLevelTypes

O código de nível.

message

string

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

time

string (date-time)

A hora do status.

KeyVaultSecretReference

Descreve uma referência ao segredo do Key Vault

Nome Tipo Descrição
secretUrl

string

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

sourceVault

SubResource

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

StatusLevelTypes

O código de nível.

Valor Descrição
Info
Warning
Error

SubResource

Nome Tipo Descrição
id

string

ID do recurso

VirtualMachineExtensionInstanceView

A exibição de instância de uma extensão de máquina virtual.

Nome Tipo Descrição
name

string

O nome da extensão da máquina virtual.

statuses

InstanceViewStatus[]

As informações de status do recurso.

substatuses

InstanceViewStatus[]

As informações de status do recurso.

type

string

Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".

typeHandlerVersion

string

Especifica a versão Major.Minor.Patch.Hotfix do handler de script. A plataforma Azure fornecerá a versão mais recente do Patch.Hotfix da série Major.Minor.

VirtualMachineScaleSetVMExtension

Descreve uma extensão VMSS VM.

Nome Tipo Descrição
id

string

ID do recurso

location

string

A localização da extensão.

name

string

Nome do recurso

properties.autoUpgradeMinorVersion

boolean

Indica se a extensão deve usar uma versão secundária mais recente, se uma estiver disponível no momento da implantação. Uma vez implantada, no entanto, a extensão não atualizará versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como true.

properties.enableAutomaticUpgrade

boolean

Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente da extensão disponível.

properties.forceUpdateTag

string

Como o manipulador de extensão deve ser forçado a atualizar mesmo que a configuração da extensão não tenha sido alterada.

properties.instanceView

VirtualMachineExtensionInstanceView

A exibição da instância de extensão de máquina virtual.

properties.protectedSettings

A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida.

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

As extensões protegem as configurações que são passadas por referência e consumidas do cofre de chaves

properties.provisionAfterExtensions

string[]

Coleção de nomes de extensão após a qual essa extensão precisa ser provisionada.

properties.provisioningState

string

O estado de provisionamento, que só aparece na resposta.

properties.publisher

string

O nome do editor do manipulador de extensão.

properties.settings

Json formatou configurações públicas para a extensão.

properties.suppressFailures

boolean

Indica se as falhas decorrentes da extensão serão suprimidas (Falhas operacionais, como não se conectar à VM, não serão suprimidas, independentemente desse valor). O valor predefinido é falso.

properties.type

string

Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".

properties.typeHandlerVersion

string

Especifica a versão Major.Minor do handler de scripts. O cliente pode especificar apenas a versão Major.Minor de uma extensão, enquanto a plataforma Azure fornecerá a versão mais recente do Patch.Hotfix da série Major.Minor.

type

string

Tipo de recurso