Compartilhar via


Virtual Machine Extensions - Create Or Update

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

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

vmExtensionName
path True

string

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

vmName
path True

string

O nome da máquina virtual em que a extensão deve ser criada ou atualizada.

api-version
query True

string

Versão da API do cliente.

Corpo da solicitação

Nome Tipo Description
location

string

Local 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 de extensão não tenha sido alterada.

properties.instanceView

VirtualMachineExtensionInstanceView

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

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.

tags

object

Marcas de recurso

Respostas

Nome Tipo Description
200 OK

VirtualMachineExtension

OKEY

201 Created

VirtualMachineExtension

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

VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen
VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen

VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/aaaaaaaaaaaaaaaaaaaaaaaa/extensions/aaaaaaaaaaaaa?api-version=2024-07-01

{
  "location": "westus",
  "properties": {
    "autoUpgradeMinorVersion": true,
    "publisher": "extPublisher",
    "type": "extType",
    "typeHandlerVersion": "1.2",
    "suppressFailures": true,
    "settings": {},
    "forceUpdateTag": "a",
    "enableAutomaticUpgrade": true,
    "protectedSettings": {},
    "instanceView": {
      "name": "aaaaaaaaaaaaaaaaa",
      "type": "aaaaaaaaa",
      "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
      "substatuses": [
        {
          "code": "aaaaaaaaaaaaaaaaaaaaaaa",
          "level": "Info",
          "displayStatus": "aaaaaa",
          "message": "a",
          "time": "2021-11-30T12:58:26.522Z"
        }
      ],
      "statuses": [
        {
          "code": "aaaaaaaaaaaaaaaaaaaaaaa",
          "level": "Info",
          "displayStatus": "aaaaaa",
          "message": "a",
          "time": "2021-11-30T12:58:26.522Z"
        }
      ]
    }
  },
  "tags": {
    "key9183": "aa"
  }
}

Resposta de exemplo

{
  "name": "myVMExtension",
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension",
  "location": "westus",
  "properties": {
    "autoUpgradeMinorVersion": true,
    "provisioningState": "Creating",
    "publisher": "extPublisher",
    "type": "extType",
    "typeHandlerVersion": "1.2",
    "suppressFailures": true,
    "settings": {},
    "forceUpdateTag": "a",
    "enableAutomaticUpgrade": true,
    "protectedSettings": {},
    "instanceView": {
      "name": "aaaaaaaaaaaaaaaaa",
      "type": "aaaaaaaaa",
      "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
      "substatuses": [
        {
          "code": "aaaaaaaaaaaaaaaaaaaaaaa",
          "level": "Info",
          "displayStatus": "aaaaaa",
          "message": "a",
          "time": "2021-11-30T12:58:26.522Z"
        }
      ],
      "statuses": [
        {
          "code": "aaaaaaaaaaaaaaaaaaaaaaa",
          "level": "Info",
          "displayStatus": "aaaaaa",
          "message": "a",
          "time": "2021-11-30T12:58:26.522Z"
        }
      ]
    }
  },
  "tags": {
    "key9183": "aa"
  }
}
location: https://foo.com/operationstatus
{
  "name": "myVMExtension",
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension",
  "location": "westus",
  "properties": {
    "autoUpgradeMinorVersion": true,
    "provisioningState": "Creating",
    "publisher": "extPublisher",
    "type": "extType",
    "typeHandlerVersion": "1.2",
    "suppressFailures": true,
    "settings": {},
    "forceUpdateTag": "a",
    "enableAutomaticUpgrade": true,
    "protectedSettings": {},
    "instanceView": {
      "name": "aaaaaaaaaaaaaaaaa",
      "type": "aaaaaaaaa",
      "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
      "substatuses": [
        {
          "code": "aaaaaaaaaaaaaaaaaaaaaaa",
          "level": "Info",
          "displayStatus": "aaaaaa",
          "message": "a",
          "time": "2021-11-30T12:58:26.522Z"
        }
      ],
      "statuses": [
        {
          "code": "aaaaaaaaaaaaaaaaaaaaaaa",
          "level": "Info",
          "displayStatus": "aaaaaa",
          "message": "a",
          "time": "2021-11-30T12:58:26.522Z"
        }
      ]
    }
  },
  "tags": {
    "key9183": "aa"
  }
}

VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension?api-version=2024-07-01

{
  "location": "westus"
}

Resposta de exemplo

{
  "location": "westus",
  "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"
}
location: https://foo.com/operationstatus
{
  "location": "westus",
  "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension"
}

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.

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
VirtualMachineExtension

Descreve uma extensão de máquina virtual.

VirtualMachineExtensionInstanceView

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

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.

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.

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.

StatusLevelTypes

O código de nível.

Nome Tipo Description
Error

string

Info

string

Warning

string

SubResource

Nome Tipo Description
id

string

ID do recurso

VirtualMachineExtension

Descreve uma extensão de máquina virtual.

Nome Tipo Description
id

string

ID do recurso

location

string

Local do recurso

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 de extensão não tenha sido alterada.

properties.instanceView

VirtualMachineExtensionInstanceView

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

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.

tags

object

Marcas de recurso

type

string

Tipo de recurso

VirtualMachineExtensionInstanceView

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

Nome Tipo Description
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 do manipulador de script.