azure.mgmt.compute.v2016_03_30.models.VirtualMachineExtension.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2016_03_30.models.VirtualMachineExtension
name: VirtualMachineExtension
fullName: azure.mgmt.compute.v2016_03_30.models.VirtualMachineExtension
module: azure.mgmt.compute.v2016_03_30.models
inheritances:
- azure.mgmt.compute.v2016_03_30.models._models_py3.Resource
summary: 'Describes a Virtual Machine Extension.


  Variables are only populated by the server, and will be ignored when sending a request.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: 'VirtualMachineExtension(*, location: str, tags: Dict[str, 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, settings: MutableMapping[str, Any] | None = None, protected_settings:
    MutableMapping[str, Any] | None = None, instance_view: _models.VirtualMachineExtensionInstanceView
    | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: location
    description: Resource location. Required.
    types:
    - <xref:str>
  - name: tags
    description: Resource tags.
    types:
    - <xref:dict>[<xref:str>, <xref:str>]
  - name: force_update_tag
    description: 'How the extension handler should 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: 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: instance_view
    description: The virtual machine extension instance view.
    types:
    - <xref:azure.mgmt.compute.v2016_03_30.models.VirtualMachineExtensionInstanceView>
variables:
- description: Resource Id.
  name: id
  types:
  - <xref:str>
- description: Resource name.
  name: name
  types:
  - <xref:str>
- description: Resource type.
  name: type
  types:
  - <xref:str>
- description: Resource location. Required.
  name: location
  types:
  - <xref:str>
- description: Resource tags.
  name: tags
  types:
  - <xref:dict>[<xref:str>, <xref:str>]
- description: 'How the extension handler should 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: 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: The virtual machine extension instance view.
  name: instance_view
  types:
  - <xref:azure.mgmt.compute.v2016_03_30.models.VirtualMachineExtensionInstanceView>