Microsoft.Compute virtualMachineScaleSets/virtualMachines/extensions 2022-11-01

• 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 virtualMachineScaleSets/virtualMachines/extensions pode ser implementado com operações que visam:

• Grupos de recursos – veja os comandos de implementação do grupo 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/virtualMachineScaleSets/virtualMachines/extensions, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2022-11-01' = {
  name: 'string'
  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

virtualMachineScaleSets/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)
principal	No Bicep, pode especificar o recurso principal de um recurso subordinado. Só tem 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 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.	Para 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
publicador	O nome do editor do processador de extensões.	string
definições	Definições públicas formatadas pelo Json para a extensão.	Para 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 é 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

Definição de recurso do modelo arm

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

• Grupos de recursos – veja os comandos de implementação do grupo 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/virtualMachineScaleSets/virtualMachines/extensions, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
  "apiVersion": "2022-11-01",
  "name": "string",
  "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

virtualMachineScaleSets/virtualMachines/extensions

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions"
apiVersion	A versão da API de recursos	'2022-11-01'
name	O nome do recurso Veja como definir nomes e tipos para recursos subordinados em modelos arm JSON.	cadeia (obrigatório)
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
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 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

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

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

• 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/virtualMachineScaleSets/virtualMachines/extensions, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2022-11-01"
  name = "string"
  parent_id = "string"
  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

virtualMachineScaleSets/virtualMachines/extensions

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2022-11-01"
name	O nome do recurso	cadeia (obrigatório)
parent_id	O ID do recurso que é o principal para este recurso.	ID 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.
protectedSettingsFromKeyVault	As definições protegidas por extensões que são transmitidas por referência e consumidas a partir do cofre de chaves	KeyVaultSecretReference
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