Microsoft.Compute virtualMachines/extensions

• Mais recente
• 2023-09-01
• 2023-07-01
• 2023-03-01
• 2022-11-01
• 2022-08-01
• 2022-03-01
• 2021-11-01
• 2021-07-01
• 2021-04-01
• 2021-03-01
• 2020-12-01

Definição de recurso do Bicep

O tipo de recurso virtualMachines/extensions pode ser implementado com operações que visam:

• Grupos de recursos – veja comandos de implementação de grupos de recursos

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

Formato do recurso

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

resource symbolicname 'Microsoft.Compute/virtualMachines/extensions@2023-09-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'
      }
    }
    provisionAfterExtensions: [
      'string'
    ]
    publisher: 'string'
    settings: any()
    suppressFailures: bool
    type: 'string'
    typeHandlerVersion: 'string'
  }
}

Valores de propriedade

virtualMachines/extensions

Nome	Descrição	Valor
name	O nome do recurso Veja como definir nomes e tipos para recursos subordinados no Bicep.	cadeia (obrigatório)
localização	Localização do recurso	string
etiquetas	Etiquetas de recursos	Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
principal	No Bicep, pode especificar o recurso principal de um recurso subordinado. Só precisa de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal. Para obter mais informações, veja Recurso subordinado fora do recurso principal.	Nome simbólico para 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 utilizar uma versão secundária mais recente se uma estiver disponível no momento da implementação. No entanto, depois de implementada, a extensão não atualizará versões secundárias, a menos que seja reimplementada, mesmo com esta propriedade definida como verdadeira.	bool
enableAutomaticUpgrade	Indica se a extensão deve ser atualizada automaticamente pela plataforma se existir uma versão mais recente da extensão disponível.	bool
forceUpdateTag	Como o processador de extensões deve ser forçado a atualizar mesmo que a configuração da extensão não tenha sido alterada.	string
instanceView	A vista de instância da extensão da máquina virtual.	VirtualMachineExtensionInstanceView
protectedSettings	A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma definição protegida.	Para o Bicep, pode utilizar a função any( ).
protectedSettingsFromKeyVault	As definições protegidas por extensões que são transmitidas por referência e consumidas a partir do cofre de chaves	KeyVaultSecretReference
provisionAfterExtensions	Coleção de nomes de extensões após o qual esta extensão tem de ser aprovisionada.	cadeia[]
publicador	O nome do editor do processador de extensões.	string
definições	Definições públicas formatadas por Json para a extensão.	Para o Bicep, pode utilizar a função any( ).
suppressFailures	Indica se as falhas decorrentes da extensão serão suprimidas (as falhas operacionais, como não ligar à VM, não serão suprimidas independentemente deste valor). A predefinição é falsa.	bool
tipo	Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".	string
typeHandlerVersion	Especifica a versão do processador de scripts.	string

VirtualMachineExtensionInstanceView

Nome	Descrição	Valor
name	O nome da extensão da máquina virtual.	string
estados	As informações do estado do recurso.	InstanceViewStatus[]
substatus	As informações do estado do recurso.	InstanceViewStatus[]
tipo	Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".	string
typeHandlerVersion	Especifica a versão do processador de scripts.	string

InstanceViewStatus

Nome	Descrição	Valor
code	O código de estado.	string
displayStatus	A etiqueta localizável curta para o estado.	string
nível	O código de nível.	"Erro" "Informações" "Aviso"
message	A mensagem de estado detalhada, incluindo para alertas e mensagens de erro.	string
hora	A hora do estado.	string

KeyVaultSecretReference

Nome	Descrição	Valor
secretUrl	O URL que referencia um segredo numa Key Vault.	cadeia (obrigatório)
sourceVault	O URL relativo do Key Vault que contém o segredo.	SubResource (obrigatório)

Sub-origem

Nome	Descrição	Valor
ID	ID do Recurso	string

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo	Description
Criar uma VM do Windows com a extensão Antimalware ativada	Este modelo cria uma VM do Windows e configura a proteção antimalware
Servidor IIS com a extensão DSC numa VM do Windows	Este modelo cria uma VM do Windows e configura um servidor IIS com a extensão DSC. Tenha em atenção que o módulo de configuração do DSC precisa que um token de SAS seja transmitido se estiver a utilizar o Armazenamento do Azure. Para a ligação do módulo DSC a partir do GitHub (predefinição neste modelo), isto não é necessário.
Extensão de VM ESET	Cria uma VM com a extensão ESET
McAfee Endpoint Security (licença de avaliação) na VM do Windows	Este modelo cria uma VM do Windows e configura uma versão de avaliação do McAfee Endpoint Security
Implementar uma VM do Ubuntu com a extensão OMS	Este modelo permite-lhe implementar uma VM do Ubuntu com a extensão OMS instalada e integrada numa área de trabalho especificada
Implementar uma VM do Windows com a extensão OMS	Este modelo permite-lhe implementar uma VM do Windows com a extensão OMS instalada e integrada numa área de trabalho especificada
Avaliação da extensão do Symantec Endpoint Protection na VM do Windows	Este modelo cria uma VM do Windows e configura uma versão de avaliação do Symantec Endpoint Protection
Extensão de Script Personalizado numa VM do Ubuntu	Este modelo cria uma VM do Ubuntu e instala a extensão CustomScript
Extensão de Aplicação de Patches do SO numa VM do Ubuntu	Este modelo cria uma VM do Ubuntu e instala a extensão OSPatching
Implementar uma VM Premium do Windows com diagnósticos	Este modelo permite-lhe implementar uma VM premium do Windows com algumas opções diferentes para a versão do Windows, com a versão mais recente corrigida.
Implementar uma VM do Windows simples com monitorização e diagnósticos	Este modelo permite-lhe implementar uma VM do Windows simples juntamente com a extensão de diagnóstico que permite a monitorização e o diagnóstico da VM
Utilizar extensões de script para instalar a BD mongo na VM do Ubuntu	Este modelo implementa Configurar e Instalar o Mongo DB numa 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. Este modelo também implementa 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 implementado com operações que visam:

• Grupos de recursos – veja comandos de implementação de grupos de recursos

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

Formato do recurso

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

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "apiVersion": "2023-09-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"
      }
    },
    "provisionAfterExtensions": [ "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 de recursos	'2023-09-01'
name	O nome do recurso Veja como definir nomes e tipos para recursos subordinados em modelos arm JSON.	cadeia (obrigatório)
localização	Localização do recurso	string
etiquetas	Etiquetas de recursos	Dicionário de nomes e valores de etiquetas. Ver Etiquetas 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 utilizar uma versão secundária mais recente se estiver disponível no momento da implementação. No entanto, depois de implementada, a extensão não atualizará versões secundárias a menos que sejam reimplementadas, mesmo com esta propriedade definida como verdadeira.	bool
enableAutomaticUpgrade	Indica se a extensão deve ser atualizada automaticamente pela plataforma se existir uma versão mais recente da extensão disponível.	bool
forceUpdateTag	Como o processador de extensões deve ser forçado a atualizar, mesmo que a configuração da extensão não tenha sido alterada.	string
instanceView	A vista de instância da extensão da máquina virtual.	VirtualMachineExtensionInstanceView
protectedSettings	A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma definição protegida.
protectedSettingsFromKeyVault	As definições protegidas por extensões que são transmitidas por referência e consumidas a partir do cofre de chaves	KeyVaultSecretReference
provisionAfterExtensions	Coleção de nomes de extensões após o qual esta extensão tem de ser aprovisionada.	string[]
publicador	O nome do editor do processador de extensões.	string
definições	Definições públicas formatadas pelo Json para a extensão.
suppressFailures	Indica se as falhas decorrentes da extensão serão suprimidas (as falhas operacionais, como não ligar à VM, não serão suprimidas independentemente deste valor). A predefinição é false.	bool
tipo	Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".	string
typeHandlerVersion	Especifica a versão do processador de scripts.	string

VirtualMachineExtensionInstanceView

Nome	Descrição	Valor
name	O nome da extensão da máquina virtual.	string
estados	As informações de estado do recurso.	InstanceViewStatus[]
substatuses	As informações de estado do recurso.	InstanceViewStatus[]
tipo	Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".	string
typeHandlerVersion	Especifica a versão do processador de scripts.	string

InstanceViewStatus

Nome	Descrição	Valor
code	O código de estado.	string
displayStatus	A etiqueta localizável curta para o estado.	string
nível	O código de nível.	"Erro" 'Informações' 'Aviso'
message	A mensagem de estado detalhada, incluindo para alertas e mensagens de erro.	string
hora	A hora do estado.	string

KeyVaultSecretReference

Nome	Descrição	Valor
secretUrl	O URL que referencia um segredo numa Key Vault.	cadeia (obrigatório)
sourceVault	O URL relativo do Key Vault que contém o segredo.	Sub-origem (obrigatório)

Sub-origem

Nome	Descrição	Valor
ID	ID do Recurso	string

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo	Description
Criar uma VM do Windows com a extensão Antimalware ativada	Este modelo cria uma VM do Windows e configura a proteção antimalware
Servidor IIS com a extensão DSC numa VM do Windows	Este modelo cria uma VM do Windows e configura um servidor IIS com a extensão DSC. Tenha em atenção que o módulo de configuração do DSC precisa de um token de SAS para ser transmitido se estiver a utilizar o Armazenamento do Azure. Para a ligação do módulo DSC a partir do GitHub (predefinição neste modelo), isto não é necessário.
Extensão de VM ESET	Cria uma VM com a extensão ESET
McAfee Endpoint Security (licença de avaliação) na VM do Windows	Este modelo cria uma VM do Windows e configura uma versão de avaliação do McAfee Endpoint Security
Implementar uma VM do Ubuntu com a extensão OMS	Este modelo permite-lhe implementar uma VM do Ubuntu com a extensão do OMS instalada e integrada numa área de trabalho especificada
Implementar uma VM do Windows com a extensão do OMS	Este modelo permite-lhe implementar uma VM do Windows com a extensão OMS instalada e integrada numa área de trabalho especificada
Avaliação da extensão do Symantec Endpoint Protection na VM do Windows	Este modelo cria uma VM do Windows e configura uma versão de avaliação do Symantec Endpoint Protection
Extensão de Script Personalizado numa VM do Ubuntu	Este modelo cria uma VM do Ubuntu e instala a extensão CustomScript
Extensão de Aplicação de Patches do SO numa VM do Ubuntu	Este modelo cria uma VM do Ubuntu e instala a extensão OSPatching
Implementar uma VM Premium do Windows com diagnósticos	Este modelo permite-lhe implementar uma VM Premium do Windows com algumas opções diferentes para a versão do Windows, utilizando a versão mais recente corrigida.
Implementar uma VM do Windows simples com monitorização e diagnóstico	Este modelo permite-lhe implementar uma VM do Windows simples juntamente com a extensão de diagnóstico que permite a monitorização e diagnóstico da VM
Utilizar extensões de script para instalar a BD Mongo na VM do Ubuntu	Este modelo implementa Configurar e Instalar o Mongo DB numa 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. Este modelo também implementa uma Conta de Armazenamento, Rede Virtual, endereços IP públicos e uma Interface de Rede.

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso virtualMachines/extensions pode ser implementado com operações direcionadas:

• Grupos de recursos

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

Formato do recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachines/extensions@2023-09-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"
        }
      }
      provisionAfterExtensions = [
        "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@2023-09-01"
name	O nome do recurso	cadeia (obrigatório)
localização	Localização do recurso	string
parent_id	O ID do recurso que é o principal para este recurso.	ID do recurso do tipo: virtualMachines
etiquetas	Etiquetas de recursos	Dicionário de nomes e valores de etiquetas.
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 utilizar uma versão secundária mais recente se estiver disponível no momento da implementação. No entanto, depois de implementada, a extensão não atualizará versões secundárias a menos que sejam reimplementadas, mesmo com esta propriedade definida como verdadeira.	bool
enableAutomaticUpgrade	Indica se a extensão deve ser atualizada automaticamente pela plataforma se existir uma versão mais recente da extensão disponível.	bool
forceUpdateTag	Como o processador de extensões deve ser forçado a atualizar, mesmo que a configuração da extensão não tenha sido alterada.	string
instanceView	A vista de instância da extensão da máquina virtual.	VirtualMachineExtensionInstanceView
protectedSettings	A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma definição protegida.
protectedSettingsFromKeyVault	As definições protegidas por extensões que são transmitidas por referência e consumidas a partir do cofre de chaves	KeyVaultSecretReference
provisionAfterExtensions	Coleção de nomes de extensões após o qual esta extensão tem de ser aprovisionada.	string[]
publicador	O nome do editor do processador de extensões.	string
definições	Definições públicas formatadas pelo Json para a extensão.
suppressFailures	Indica se as falhas decorrentes da extensão serão suprimidas (as falhas operacionais, como não ligar à VM, não serão suprimidas independentemente deste valor). A predefinição é false.	bool
tipo	Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".	string
typeHandlerVersion	Especifica a versão do processador de scripts.	string

VirtualMachineExtensionInstanceView

Nome	Descrição	Valor
name	O nome da extensão da máquina virtual.	string
estados	As informações de estado do recurso.	InstanceViewStatus[]
substatuses	As informações de estado do recurso.	InstanceViewStatus[]
tipo	Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".	string
typeHandlerVersion	Especifica a versão do processador de scripts.	string

InstanceViewStatus

Nome	Descrição	Valor
code	O código de estado.	string
displayStatus	A etiqueta localizável curta para o estado.	string
nível	O código de nível.	"Erro" "Informações" "Aviso"
message	A mensagem de estado detalhada, incluindo para alertas e mensagens de erro.	string
hora	A hora do estado.	string

KeyVaultSecretReference

Nome	Descrição	Valor
secretUrl	O URL que referencia um segredo numa Key Vault.	cadeia (obrigatório)
sourceVault	O URL relativo do Key Vault que contém o segredo.	Sub-origem (obrigatório)

Sub-origem

Nome	Descrição	Valor
ID	ID do Recurso	string