azure.mgmt.compute.v2022_03_01.models.VirtualMachineScaleSetExtension.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2022_03_01.models.VirtualMachineScaleSetExtension
name: VirtualMachineScaleSetExtension
fullName: azure.mgmt.compute.v2022_03_01.models.VirtualMachineScaleSetExtension
module: azure.mgmt.compute.v2022_03_01.models
inheritances:
- azure.mgmt.compute.v2022_03_01.models._models_py3.SubResourceReadOnly
summary: 'Describes a Virtual Machine Scale Set Extension.


  Variables are only populated by the server, and will be ignored when sending a request.'
constructor:
  syntax: 'VirtualMachineScaleSetExtension(*, name: str | None = None, force_update_tag:
    str | None = None, publisher: str | None = None, type_properties_type: str | None
    = None, type_handler_version: str | None = None, auto_upgrade_minor_version: bool
    | None = None, enable_automatic_upgrade: bool | None = None, settings: MutableMapping[str,
    Any] | None = None, protected_settings: MutableMapping[str, Any] | None = None,
    provision_after_extensions: List[str] | None = None, suppress_failures: bool |
    None = None, protected_settings_from_key_vault: _models.KeyVaultSecretReference
    | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: name
    description: The name of the extension.
    types:
    - <xref:str>
  - name: force_update_tag
    description: 'If a value is provided and is different from the previous value,
      the

      extension handler will be forced to update even if the extension configuration
      has not changed.'
    types:
    - <xref:str>
  - name: publisher
    description: The name of the extension handler publisher.
    types:
    - <xref:str>
  - name: type_properties_type
    description: 'Specifies the type of the extension; an example is

      "CustomScriptExtension".'
    types:
    - <xref:str>
  - name: type_handler_version
    description: Specifies the version of the script handler.
    types:
    - <xref:str>
  - name: auto_upgrade_minor_version
    description: 'Indicates whether the extension should use a newer minor

      version if one is available at deployment time. Once deployed, however, the
      extension will not

      upgrade minor versions unless redeployed, even with this property set to true.'
    types:
    - <xref:bool>
  - name: enable_automatic_upgrade
    description: 'Indicates whether the extension should be automatically

      upgraded by the platform if there is a newer version of the extension available.'
    types:
    - <xref:bool>
  - name: settings
    description: Json formatted public settings for the extension.
    types:
    - <xref:JSON>
  - name: protected_settings
    description: 'The extension can contain either protectedSettings or

      protectedSettingsFromKeyVault or no protected settings at all.'
    types:
    - <xref:JSON>
  - name: provision_after_extensions
    description: 'Collection of extension names after which this extension

      needs to be provisioned.'
    types:
    - <xref:list>[<xref:str>]
  - name: suppress_failures
    description: 'Indicates whether failures stemming from the extension will be

      suppressed (Operational failures such as not connecting to the VM will not be
      suppressed

      regardless of this value). The default is false.'
    types:
    - <xref:bool>
  - name: protected_settings_from_key_vault
    description: 'The extensions protected settings that are passed

      by reference, and consumed from key vault.'
    types:
    - <xref:azure.mgmt.compute.v2022_03_01.models.KeyVaultSecretReference>
variables:
- description: Resource Id.
  name: id
  types:
  - <xref:str>
- description: The name of the extension.
  name: name
  types:
  - <xref:str>
- description: Resource type.
  name: type
  types:
  - <xref:str>
- description: 'If a value is provided and is different from the previous value, the

    extension handler will be forced to update even if the extension configuration
    has not changed.'
  name: force_update_tag
  types:
  - <xref:str>
- description: The name of the extension handler publisher.
  name: publisher
  types:
  - <xref:str>
- description: 'Specifies the type of the extension; an example is

    "CustomScriptExtension".'
  name: type_properties_type
  types:
  - <xref:str>
- description: Specifies the version of the script handler.
  name: type_handler_version
  types:
  - <xref:str>
- description: 'Indicates whether the extension should use a newer minor

    version if one is available at deployment time. Once deployed, however, the extension
    will not

    upgrade minor versions unless redeployed, even with this property set to true.'
  name: auto_upgrade_minor_version
  types:
  - <xref:bool>
- description: 'Indicates whether the extension should be automatically

    upgraded by the platform if there is a newer version of the extension available.'
  name: enable_automatic_upgrade
  types:
  - <xref:bool>
- description: Json formatted public settings for the extension.
  name: settings
  types:
  - <xref:JSON>
- description: 'The extension can contain either protectedSettings or

    protectedSettingsFromKeyVault or no protected settings at all.'
  name: protected_settings
  types:
  - <xref:JSON>
- description: The provisioning state, which only appears in the response.
  name: provisioning_state
  types:
  - <xref:str>
- description: 'Collection of extension names after which this extension

    needs to be provisioned.'
  name: provision_after_extensions
  types:
  - <xref:list>[<xref:str>]
- description: 'Indicates whether failures stemming from the extension will be

    suppressed (Operational failures such as not connecting to the VM will not be
    suppressed

    regardless of this value). The default is false.'
  name: suppress_failures
  types:
  - <xref:bool>
- description: 'The extensions protected settings that are passed by

    reference, and consumed from key vault.'
  name: protected_settings_from_key_vault
  types:
  - <xref:azure.mgmt.compute.v2022_03_01.models.KeyVaultSecretReference>