Compartilhar via


Virtual Machine Scale Set Extensions - Update

A operação para atualizar uma extensão.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}?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.

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.

vmScaleSetName
path True

string

O nome do conjunto de dimensionamento de VM em que a extensão deve ser atualizada.

vmssExtensionName
path True

string

O nome da extensão do conjunto de dimensionamento da VM.

api-version
query True

string

Versão da API do cliente.

Corpo da solicitação

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

Se um valor for fornecido e for diferente do valor anterior, o manipulador de extensão será forçado a atualizar mesmo que a configuração de extensão não tenha sido alterada.

properties.protectedSettings

object

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

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

As configurações protegidas de extensõ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 o qual essa extensão precisa ser provisionada.

properties.publisher

string

O nome do editor do manipulador de extensão.

properties.settings

object

Configurações públicas formatadas em Json 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 padrão é false.

properties.type

string

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

properties.typeHandlerVersion

string

Especifica a versão do manipulador de script.

Respostas

Nome Tipo Description
200 OK

VirtualMachineScaleSetExtension

OKEY

201 Created

VirtualMachineScaleSetExtension

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

VirtualMachineScaleSetExtension_Update_MaximumSet_Gen
VirtualMachineScaleSetExtension_Update_MinimumSet_Gen

VirtualMachineScaleSetExtension_Update_MaximumSet_Gen

Solicitação de exemplo

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaaaaaaaaa/extensions/aaaa?api-version=2024-07-01

{
  "properties": {
    "autoUpgradeMinorVersion": true,
    "publisher": "{extension-Publisher}",
    "type": "{extension-Type}",
    "typeHandlerVersion": "{handler-version}",
    "settings": {},
    "forceUpdateTag": "aaaaaaaaa",
    "enableAutomaticUpgrade": true,
    "protectedSettings": {},
    "provisionAfterExtensions": [
      "aa"
    ],
    "suppressFailures": true
  }
}

Resposta de exemplo

{
  "name": "{extension-name}",
  "properties": {
    "autoUpgradeMinorVersion": true,
    "publisher": "{extension-Publisher}",
    "type": "{extension-Type}",
    "typeHandlerVersion": "{handler-version}",
    "settings": {},
    "forceUpdateTag": "aaaaaaaaa",
    "enableAutomaticUpgrade": true,
    "protectedSettings": {},
    "provisioningState": "aaa",
    "provisionAfterExtensions": [
      "aa"
    ],
    "suppressFailures": true
  },
  "type": "aaaaaaaaaaaaaaaaaaaaaaaa",
  "id": "aaaaaaaa"
}
location: https://foo.com/operationstatus
{
  "name": "{extension-name}",
  "properties": {
    "autoUpgradeMinorVersion": true,
    "publisher": "{extension-Publisher}",
    "type": "{extension-Type}",
    "typeHandlerVersion": "{handler-version}",
    "settings": {},
    "forceUpdateTag": "aaaaaaaaa",
    "enableAutomaticUpgrade": true,
    "protectedSettings": {},
    "provisioningState": "aaa",
    "provisionAfterExtensions": [
      "aa"
    ],
    "suppressFailures": true
  },
  "type": "aaaaaaaaaaaaaaaaaaaaaaaa",
  "id": "aaaaaaaa"
}

VirtualMachineScaleSetExtension_Update_MinimumSet_Gen

Solicitação de exemplo

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaaaaaa/extensions/aa?api-version=2024-07-01

{}

Resposta de exemplo

{}
location: https://foo.com/operationstatus
{}

Definições

Nome Description
ApiError

Erro de API.

ApiErrorBase

Base de erros de API.

CloudError

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

InnerError

Detalhes do erro interno.

KeyVaultSecretReference

Descreve uma referência ao Segredo do Key Vault

SubResource
VirtualMachineScaleSetExtension

Descreve uma extensão do conjunto de dimensionamento de máquinas virtuais.

VirtualMachineScaleSetExtensionUpdate

Descreve uma extensão do conjunto de dimensionamento de máquinas virtuais.

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.

CloudError

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

Nome Tipo Description
error

ApiError

Erro de API.

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.

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.

SubResource

Nome Tipo Description
id

string

ID do recurso

VirtualMachineScaleSetExtension

Descreve uma extensão do conjunto de dimensionamento de máquinas virtuais.

Nome Tipo Description
id

string

ID do recurso

name

string

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

Se um valor for fornecido e for diferente do valor anterior, o manipulador de extensão será forçado a atualizar mesmo que a configuração de extensão não tenha sido alterada.

properties.protectedSettings

object

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

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

As configurações protegidas de extensõ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 o qual essa extensão precisa ser provisionada.

properties.provisioningState

string

O estado de provisionamento, que aparece apenas na resposta.

properties.publisher

string

O nome do editor do manipulador de extensão.

properties.settings

object

Configurações públicas formatadas em Json 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 padrão é false.

properties.type

string

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

properties.typeHandlerVersion

string

Especifica a versão do manipulador de script.

type

string

Tipo de recurso

VirtualMachineScaleSetExtensionUpdate

Descreve uma extensão do conjunto de dimensionamento de máquinas virtuais.

Nome Tipo Description
id

string

ID do recurso

name

string

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

Se um valor for fornecido e for diferente do valor anterior, o manipulador de extensão será forçado a atualizar mesmo que a configuração de extensão não tenha sido alterada.

properties.protectedSettings

object

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

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

As configurações protegidas de extensõ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 o qual essa extensão precisa ser provisionada.

properties.provisioningState

string

O estado de provisionamento, que aparece apenas na resposta.

properties.publisher

string

O nome do editor do manipulador de extensão.

properties.settings

object

Configurações públicas formatadas em Json 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 padrão é false.

properties.type

string

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

properties.typeHandlerVersion

string

Especifica a versão do manipulador de script.

type

string

Tipo de recurso