Microsoft.Compute virtualMachines/extensions
Definição de recurso do Bicep
O tipo de recurso virtualMachines/extensions pode ser implantado com operações direcionadas:
- Grupos de recursos – Consulte comandos de implantação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, consulte 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@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 filho no Bicep. |
cadeia de caracteres (obrigatório) |
| local | Localização do recurso | string |
| marcas | Marcações de recursos | Dicionário de nomes e valores de marcas. Confira 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 para o recurso do tipo: virtualMachines |
| properties | 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. Após a implantação, no entanto, a extensão não atualizará as versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como verdadeira. | 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 da extensão não tenha sido alterada. | string |
| Instanceview | A 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 por extensões que são passadas por referência e consumidas do cofre de chaves | KeyVaultSecretReference |
| provisionAfterExtensions | Coleção de nomes de extensão após os quais essa extensão precisa ser provisionada. | string[] |
| publicador | O nome do editor do manipulador de extensão. | string |
| 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". | string |
| typeHandlerVersion | Especifica a versão do manipulador de script. | string |
VirtualMachineExtensionInstanceView
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome da extensão da máquina virtual. | string |
| status | O recurso status informações. | InstanceViewStatus[] |
| substatuses | O recurso status informações. | InstanceViewStatus[] |
| tipo | Especifica o tipo da extensão; um exemplo é "CustomScriptExtension". | string |
| typeHandlerVersion | Especifica a versão do manipulador de script. | string |
InstanceViewStatus
| Nome | Descrição | Valor |
|---|---|---|
| code | O código do status. | string |
| displayStatus | O rótulo localizável curto para o status. | string |
| nível | O código de nível. | 'Error' 'Info' 'Aviso' |
| message | A mensagem de status detalhada, inclusive para alertas e mensagens de erro. | string |
| time | A hora do status. | string |
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 | string |
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 |
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 |
Este 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 que um token SAS seja 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. |
| 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 |
| Implantar uma VM do Ubuntu com a extensão do OMS |
Este 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 |
Este modelo permite implantar uma VM do Windows com a extensão OMS instalada e integrada a um workspace especificado |
| 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 em uma VM do Ubuntu |
Este modelo cria uma VM do Ubuntu e instala a extensão CustomScript |
| Extensão de aplicação de patch do sistema operacional em uma VM do Ubuntu |
Este modelo cria uma VM do Ubuntu e instala a extensão OSPatching |
| Implantar uma VM Premium do Windows com diagnóstico |
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 corrigida. |
| Implantar uma VM simples do Windows com monitoramento e diagnóstico |
Este modelo permite implantar uma VM simples do Windows junto com a extensão diagnóstico que permite o monitoramento e diagnóstico para a VM |
| Usar extensões de script para instalar o Mongo DB na VM do Ubuntu |
Este modelo implanta Configurar 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 um adaptador de rede. |
Definição de recurso de modelo do ARM
O tipo de recurso virtualMachines/extensions pode ser implantado com operações direcionadas:
- Grupos de recursos – Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Compute/virtualMachines/extensions, adicione o JSON a seguir ao 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 do recurso | '2023-09-01' |
| name | O nome do recurso Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON. |
cadeia de caracteres (obrigatório) |
| local | Localização do recurso | string |
| marcas | Marcações de recursos | Dicionário de nomes e valores de marcas. Confira Marcas em modelos |
| properties | 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. Após a implantação, no entanto, a extensão não atualizará as versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como verdadeira. | 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 da extensão não tenha sido alterada. | string |
| Instanceview | A 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 por extensões que são passadas por referência e consumidas do cofre de chaves | KeyVaultSecretReference |
| provisionAfterExtensions | Coleção de nomes de extensão após os quais essa extensão precisa ser provisionada. | string[] |
| publicador | O nome do editor do manipulador de extensão. | string |
| 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". | string |
| typeHandlerVersion | Especifica a versão do manipulador de script. | string |
VirtualMachineExtensionInstanceView
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome da extensão da máquina virtual. | string |
| status | O recurso status informações. | InstanceViewStatus[] |
| substatuses | O recurso status informações. | InstanceViewStatus[] |
| tipo | Especifica o tipo da extensão; um exemplo é "CustomScriptExtension". | string |
| typeHandlerVersion | Especifica a versão do manipulador de script. | string |
InstanceViewStatus
| Nome | Descrição | Valor |
|---|---|---|
| code | O código do status. | string |
| displayStatus | O rótulo localizável curto para o status. | string |
| nível | O código de nível. | 'Error' 'Info' 'Aviso' |
| message | A mensagem de status detalhada, inclusive para alertas e mensagens de erro. | string |
| time | A hora da status. | string |
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 | string |
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 |
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 |
Este 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 que um token SAS seja 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. |
| 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 |
| Implantar uma VM do Ubuntu com a extensão do OMS |
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 |
Este modelo permite que você implante 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 |
Este modelo cria uma VM do Windows e configura uma versão de avaliação do Symantec Endpoint Protection |
| Extensão de script personalizado em uma VM do Ubuntu |
Este modelo cria uma VM do Ubuntu e instala a extensão CustomScript |
| Extensão de aplicação de patch do sistema operacional em uma VM do Ubuntu |
Este modelo cria uma VM do Ubuntu e instala a extensão OSPatching |
| Implantar uma VM Premium do Windows com diagnóstico |
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 simples do Windows com monitoramento e diagnóstico |
Este modelo permite que você implante uma VM simples do Windows junto com a extensão diagnóstico que permite o monitoramento e a diagnóstico para a VM |
| Usar extensões de script para instalar o Mongo DB na VM do Ubuntu |
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 um adaptador de rede. |
Definição de recurso do Terraform (provedor de AzAPI)
O tipo de recurso virtualMachines/extensions pode ser implantado com operações direcionadas:
- Grupos de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.Compute/virtualMachines/extensions, adicione o Terraform a seguir ao 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 de caracteres (obrigatório) |
| local | Localização do recurso | string |
| parent_id | A ID do recurso que é o pai desse recurso. | ID do recurso do tipo: virtualMachines |
| marcas | Marcações de recursos | Dicionário de nomes e valores de marcas. |
| properties | 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. Após a implantação, no entanto, a extensão não atualizará as versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como verdadeira. | 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 da extensão não tenha sido alterada. | string |
| Instanceview | A 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 por extensões que são passadas por referência e consumidas do cofre de chaves | KeyVaultSecretReference |
| provisionAfterExtensions | Coleção de nomes de extensão após os quais essa extensão precisa ser provisionada. | string[] |
| publicador | O nome do editor do manipulador de extensão. | string |
| 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". | string |
| typeHandlerVersion | Especifica a versão do manipulador de script. | string |
VirtualMachineExtensionInstanceView
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome da extensão da máquina virtual. | string |
| status | O recurso status informações. | InstanceViewStatus[] |
| substatuses | O recurso status informações. | InstanceViewStatus[] |
| tipo | Especifica o tipo da extensão; um exemplo é "CustomScriptExtension". | string |
| typeHandlerVersion | Especifica a versão do manipulador de script. | string |
InstanceViewStatus
| Nome | Descrição | Valor |
|---|---|---|
| code | O código do status. | string |
| displayStatus | O rótulo localizável curto para o status. | string |
| nível | O código de nível. | "Erro" "Informações" "Warning" |
| message | A mensagem de status detalhada, inclusive para alertas e mensagens de erro. | string |
| time | A hora da status. | string |
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 | string |
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de