Compartilhar via


Microsoft.Compute virtualMachines/extensions 2022-11-01

Definição de recurso do Bicep

O tipo de recurso virtualMachines/extensions pode ser implantado com operações de destino:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Compute/virtualMachines/extensions, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.Compute/virtualMachines/extensions@2022-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    autoUpgradeMinorVersion: bool
    enableAutomaticUpgrade: bool
    forceUpdateTag: 'string'
    instanceView: {
      name: 'string'
      statuses: [
        {
          code: 'string'
          displayStatus: 'string'
          level: 'string'
          message: 'string'
          time: 'string'
        }
      ]
      substatuses: [
        {
          code: 'string'
          displayStatus: 'string'
          level: 'string'
          message: 'string'
          time: 'string'
        }
      ]
      type: 'string'
      typeHandlerVersion: 'string'
    }
    protectedSettings: any()
    protectedSettingsFromKeyVault: {
      secretUrl: 'string'
      sourceVault: {
        id: 'string'
      }
    }
    publisher: 'string'
    settings: any()
    suppressFailures: bool
    type: 'string'
    typeHandlerVersion: 'string'
  }
}

Valores de propriedade

virtualMachines/extensions

Nome Descrição Valor
nome O nome do recurso

Veja como definir nomes e tipos para recursos filho no Bicep.
cadeia de caracteres (obrigatório)
localização Local do recurso corda
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.
Nome simbólico do recurso do tipo: virtualMachines
Propriedades Descreve as propriedades de uma extensão de máquina virtual. VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Nome Descrição Valor
autoUpgradeMinorVersion 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. Bool
enableAutomaticUpgrade Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente da extensão disponível. Bool
forceUpdateTag 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. corda
instanceView O modo de exibição da instância de extensão da máquina virtual. VirtualMachineExtensionInstanceView
protectedSettings A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida. Para o Bicep, você pode usar a função any().
protectedSettingsFromKeyVault As configurações protegidas de extensões que são passadas por referência e consumidas do cofre de chaves KeyVaultSecretReference
editor O nome do editor do manipulador de extensão. corda
Configurações Configurações públicas formatadas em Json para a extensão. Para o Bicep, você pode usar a função any().
suppressFailures 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. Bool
tipo Especifica o tipo da extensão; um exemplo é "CustomScriptExtension". corda
typeHandlerVersion Especifica a versão do manipulador de script. corda

VirtualMachineExtensionInstanceView

Nome Descrição Valor
nome O nome da extensão da máquina virtual. corda
Status As informações de status do recurso. InstanceViewStatus []
substatuses As informações de status do recurso. InstanceViewStatus []
tipo Especifica o tipo da extensão; um exemplo é "CustomScriptExtension". corda
typeHandlerVersion Especifica a versão do manipulador de script. corda

InstanceViewStatus

Nome Descrição Valor
código O código de status. corda
displayStatus O rótulo localizável curto para o status. corda
nível O código de nível. 'Erro'
'Informações'
'Aviso'
Mensagem A mensagem de status detalhada, inclusive para alertas e mensagens de erro. corda
Hora A hora do status. corda

KeyVaultSecretReference

Nome Descrição Valor
secretUrl A URL que faz referência a um segredo em um Key Vault. cadeia de caracteres (obrigatório)
sourceVault A URL relativa do Key Vault que contém o segredo. SubResource (obrigatório)

SubResource

Nome Descrição Valor
id ID do recurso corda

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Criar uma VM do Windows com a extensão antimalware habilitada

Implantar no Azure
Este modelo cria uma VM do Windows e configura a proteção antimalware
servidor IIS usando a extensão DSC em uma VM do Windows

Implantar no Azure
Esse modelo cria uma VM do Windows e configura um servidor IIS usando a extensão DSC. Observe que o módulo de configuração de DSC precisa de um token SAS para ser passado se você estiver usando o Armazenamento do Azure. Para o link do módulo DSC do GitHub (padrão neste modelo), isso não é necessário.
de extensão de VM ESET

Implantar no Azure
Cria uma VM com extensão ESET
McAfee Endpoint Security (licença de avaliação) na VM do Windows

Implantar no Azure
Este modelo cria uma VM do Windows e configura uma versão de avaliação do McAfee Endpoint Security
implantar uma VM do Ubuntu com a extensão do OMS

Implantar no Azure
Esse modelo permite implantar uma VM do Ubuntu com a extensão do OMS instalada e integrada a um workspace especificado
implantar uma VM do Windows com a extensão do OMS

Implantar no Azure
Esse modelo permite implantar uma VM do Windows com a extensão do OMS instalada e integrada a um workspace especificado
avaliação da extensão do Symantec Endpoint Protection na VM do Windows

Implantar no Azure
Este modelo cria uma VM do Windows e configura uma versão de avaliação do Symantec Endpoint Protection
extensão script personalizado em uma VM do Ubuntu

Implantar no Azure
Este modelo cria uma VM do Ubuntu e instala a extensão CustomScript
extensão de patch do sistema operacional em uma VM do Ubuntu

Implantar no Azure
Este modelo cria uma VM do Ubuntu e instala a extensão OSPatching
implantar uma VM Premium do Windows com de diagnóstico

Implantar no Azure
Esse modelo permite implantar uma VM Premium do Windows usando algumas opções diferentes para a versão do Windows, usando a versão mais recente com patch.
implantar uma VM do Windows simples com monitoramento e diagnóstico

Implantar no Azure
Esse modelo permite implantar uma VM simples do Windows junto com a extensão de diagnóstico que permite o monitoramento e o diagnóstico para a VM
Usar extensões de script para instalar o Mongo DB na VM do Ubuntu

Implantar no Azure
Este modelo implanta Configurações e instala o Mongo DB em uma Máquina Virtual do Ubuntu em dois scripts separados. Este modelo é um bom exemplo que mostra como expressar dependências entre dois scripts em execução na mesma máquina virtual. Esse modelo também implanta uma conta de armazenamento, rede virtual, endereços IP públicos e uma interface de rede.

Definição de recurso de modelo do ARM

O tipo de recurso virtualMachines/extensions pode ser implantado com operações de destino:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Compute/virtualMachines/extensions, adicione o JSON a seguir ao seu modelo.

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "apiVersion": "2022-11-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "autoUpgradeMinorVersion": "bool",
    "enableAutomaticUpgrade": "bool",
    "forceUpdateTag": "string",
    "instanceView": {
      "name": "string",
      "statuses": [
        {
          "code": "string",
          "displayStatus": "string",
          "level": "string",
          "message": "string",
          "time": "string"
        }
      ],
      "substatuses": [
        {
          "code": "string",
          "displayStatus": "string",
          "level": "string",
          "message": "string",
          "time": "string"
        }
      ],
      "type": "string",
      "typeHandlerVersion": "string"
    },
    "protectedSettings": {},
    "protectedSettingsFromKeyVault": {
      "secretUrl": "string",
      "sourceVault": {
        "id": "string"
      }
    },
    "publisher": "string",
    "settings": {},
    "suppressFailures": "bool",
    "type": "string",
    "typeHandlerVersion": "string"
  }
}

Valores de propriedade

virtualMachines/extensions

Nome Descrição Valor
tipo O tipo de recurso 'Microsoft.Compute/virtualMachines/extensions'
apiVersion A versão da API do recurso '2022-11-01'
nome O nome do recurso

Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.
cadeia de caracteres (obrigatório)
localização Local do recurso corda
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
Propriedades Descreve as propriedades de uma extensão de máquina virtual. VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Nome Descrição Valor
autoUpgradeMinorVersion 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. Bool
enableAutomaticUpgrade Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente da extensão disponível. Bool
forceUpdateTag 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. corda
instanceView O modo de exibição da instância de extensão da máquina virtual. VirtualMachineExtensionInstanceView
protectedSettings A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida.
protectedSettingsFromKeyVault As configurações protegidas de extensões que são passadas por referência e consumidas do cofre de chaves KeyVaultSecretReference
editor O nome do editor do manipulador de extensão. corda
Configurações Configurações públicas formatadas em Json para a extensão.
suppressFailures 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. Bool
tipo Especifica o tipo da extensão; um exemplo é "CustomScriptExtension". corda
typeHandlerVersion Especifica a versão do manipulador de script. corda

VirtualMachineExtensionInstanceView

Nome Descrição Valor
nome O nome da extensão da máquina virtual. corda
Status As informações de status do recurso. InstanceViewStatus []
substatuses As informações de status do recurso. InstanceViewStatus []
tipo Especifica o tipo da extensão; um exemplo é "CustomScriptExtension". corda
typeHandlerVersion Especifica a versão do manipulador de script. corda

InstanceViewStatus

Nome Descrição Valor
código O código de status. corda
displayStatus O rótulo localizável curto para o status. corda
nível O código de nível. 'Erro'
'Informações'
'Aviso'
Mensagem A mensagem de status detalhada, inclusive para alertas e mensagens de erro. corda
Hora A hora do status. corda

KeyVaultSecretReference

Nome Descrição Valor
secretUrl A URL que faz referência a um segredo em um Key Vault. cadeia de caracteres (obrigatório)
sourceVault A URL relativa do Key Vault que contém o segredo. SubResource (obrigatório)

SubResource

Nome Descrição Valor
id ID do recurso corda

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Criar uma VM do Windows com a extensão antimalware habilitada

Implantar no Azure
Este modelo cria uma VM do Windows e configura a proteção antimalware
servidor IIS usando a extensão DSC em uma VM do Windows

Implantar no Azure
Esse modelo cria uma VM do Windows e configura um servidor IIS usando a extensão DSC. Observe que o módulo de configuração de DSC precisa de um token SAS para ser passado se você estiver usando o Armazenamento do Azure. Para o link do módulo DSC do GitHub (padrão neste modelo), isso não é necessário.
de extensão de VM ESET

Implantar no Azure
Cria uma VM com extensão ESET
McAfee Endpoint Security (licença de avaliação) na VM do Windows

Implantar no Azure
Este modelo cria uma VM do Windows e configura uma versão de avaliação do McAfee Endpoint Security
implantar uma VM do Ubuntu com a extensão do OMS

Implantar no Azure
Esse modelo permite implantar uma VM do Ubuntu com a extensão do OMS instalada e integrada a um workspace especificado
implantar uma VM do Windows com a extensão do OMS

Implantar no Azure
Esse modelo permite implantar uma VM do Windows com a extensão do OMS instalada e integrada a um workspace especificado
avaliação da extensão do Symantec Endpoint Protection na VM do Windows

Implantar no Azure
Este modelo cria uma VM do Windows e configura uma versão de avaliação do Symantec Endpoint Protection
extensão script personalizado em uma VM do Ubuntu

Implantar no Azure
Este modelo cria uma VM do Ubuntu e instala a extensão CustomScript
extensão de patch do sistema operacional em uma VM do Ubuntu

Implantar no Azure
Este modelo cria uma VM do Ubuntu e instala a extensão OSPatching
implantar uma VM Premium do Windows com de diagnóstico

Implantar no Azure
Esse modelo permite implantar uma VM Premium do Windows usando algumas opções diferentes para a versão do Windows, usando a versão mais recente com patch.
implantar uma VM do Windows simples com monitoramento e diagnóstico

Implantar no Azure
Esse modelo permite implantar uma VM simples do Windows junto com a extensão de diagnóstico que permite o monitoramento e o diagnóstico para a VM
Usar extensões de script para instalar o Mongo DB na VM do Ubuntu

Implantar no Azure
Este modelo implanta Configurações e instala o Mongo DB em uma Máquina Virtual do Ubuntu em dois scripts separados. Este modelo é um bom exemplo que mostra como expressar dependências entre dois scripts em execução na mesma máquina virtual. Esse modelo também implanta uma conta de armazenamento, rede virtual, endereços IP públicos e uma interface de rede.

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso virtualMachines/extensions pode ser implantado com operações de destino:

  • grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Compute/virtualMachines/extensions, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachines/extensions@2022-11-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      autoUpgradeMinorVersion = bool
      enableAutomaticUpgrade = bool
      forceUpdateTag = "string"
      instanceView = {
        name = "string"
        statuses = [
          {
            code = "string"
            displayStatus = "string"
            level = "string"
            message = "string"
            time = "string"
          }
        ]
        substatuses = [
          {
            code = "string"
            displayStatus = "string"
            level = "string"
            message = "string"
            time = "string"
          }
        ]
        type = "string"
        typeHandlerVersion = "string"
      }
      protectedSettingsFromKeyVault = {
        secretUrl = "string"
        sourceVault = {
          id = "string"
        }
      }
      publisher = "string"
      suppressFailures = bool
      type = "string"
      typeHandlerVersion = "string"
    }
  })
}

Valores de propriedade

virtualMachines/extensions

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.Compute/virtualMachines/extensions@2022-11-01"
nome O nome do recurso cadeia de caracteres (obrigatório)
localização Local do recurso corda
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: virtualMachines
Tags Marcas de recurso Dicionário de nomes e valores de marca.
Propriedades Descreve as propriedades de uma extensão de máquina virtual. VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Nome Descrição Valor
autoUpgradeMinorVersion 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. Bool
enableAutomaticUpgrade Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente da extensão disponível. Bool
forceUpdateTag 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. corda
instanceView O modo de exibição da instância de extensão da máquina virtual. VirtualMachineExtensionInstanceView
protectedSettings A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida.
protectedSettingsFromKeyVault As configurações protegidas de extensões que são passadas por referência e consumidas do cofre de chaves KeyVaultSecretReference
editor O nome do editor do manipulador de extensão. corda
Configurações Configurações públicas formatadas em Json para a extensão.
suppressFailures 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. Bool
tipo Especifica o tipo da extensão; um exemplo é "CustomScriptExtension". corda
typeHandlerVersion Especifica a versão do manipulador de script. corda

VirtualMachineExtensionInstanceView

Nome Descrição Valor
nome O nome da extensão da máquina virtual. corda
Status As informações de status do recurso. InstanceViewStatus []
substatuses As informações de status do recurso. InstanceViewStatus []
tipo Especifica o tipo da extensão; um exemplo é "CustomScriptExtension". corda
typeHandlerVersion Especifica a versão do manipulador de script. corda

InstanceViewStatus

Nome Descrição Valor
código O código de status. corda
displayStatus O rótulo localizável curto para o status. corda
nível O código de nível. "Erro"
"Informações"
"Aviso"
Mensagem A mensagem de status detalhada, inclusive para alertas e mensagens de erro. corda
Hora A hora do status. corda

KeyVaultSecretReference

Nome Descrição Valor
secretUrl A URL que faz referência a um segredo em um Key Vault. cadeia de caracteres (obrigatório)
sourceVault A URL relativa do Key Vault que contém o segredo. SubResource (obrigatório)

SubResource

Nome Descrição Valor
id ID do recurso corda