VirtualMachineScaleSetExtension.yml

### YamlMime:TSType
name: VirtualMachineScaleSetExtension
uid: '@azure/arm-compute.VirtualMachineScaleSetExtension'
package: '@azure/arm-compute'
summary: Describes a Virtual Machine Scale Set Extension.
fullName: VirtualMachineScaleSetExtension
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: autoUpgradeMinorVersion
    uid: '@azure/arm-compute.VirtualMachineScaleSetExtension.autoUpgradeMinorVersion'
    package: '@azure/arm-compute'
    summary: >-
      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.
    fullName: autoUpgradeMinorVersion
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'autoUpgradeMinorVersion?: boolean'
      return:
        description: ''
        type: boolean
  - name: enableAutomaticUpgrade
    uid: '@azure/arm-compute.VirtualMachineScaleSetExtension.enableAutomaticUpgrade'
    package: '@azure/arm-compute'
    summary: >-
      Indicates whether the extension should be automatically upgraded by the
      platform if there is a newer version of the extension available.
    fullName: enableAutomaticUpgrade
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'enableAutomaticUpgrade?: boolean'
      return:
        description: ''
        type: boolean
  - name: forceUpdateTag
    uid: '@azure/arm-compute.VirtualMachineScaleSetExtension.forceUpdateTag'
    package: '@azure/arm-compute'
    summary: >-
      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.
    fullName: forceUpdateTag
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'forceUpdateTag?: string'
      return:
        description: ''
        type: string
  - name: name
    uid: '@azure/arm-compute.VirtualMachineScaleSetExtension.name'
    package: '@azure/arm-compute'
    summary: The name of the extension.
    fullName: name
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'name?: string'
      return:
        description: ''
        type: string
  - name: protectedSettings
    uid: '@azure/arm-compute.VirtualMachineScaleSetExtension.protectedSettings'
    package: '@azure/arm-compute'
    summary: >-
      The extension can contain either protectedSettings or
      protectedSettingsFromKeyVault or no protected settings at all.
    fullName: protectedSettings
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'protectedSettings?: any'
      return:
        description: ''
        type: any
  - name: protectedSettingsFromKeyVault
    uid: >-
      @azure/arm-compute.VirtualMachineScaleSetExtension.protectedSettingsFromKeyVault
    package: '@azure/arm-compute'
    summary: >-
      The extensions protected settings that are passed by reference, and
      consumed from key vault
    fullName: protectedSettingsFromKeyVault
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'protectedSettingsFromKeyVault?: KeyVaultSecretReference'
      return:
        description: ''
        type: <xref uid="@azure/arm-compute.KeyVaultSecretReference" />
  - name: provisionAfterExtensions
    uid: >-
      @azure/arm-compute.VirtualMachineScaleSetExtension.provisionAfterExtensions
    package: '@azure/arm-compute'
    summary: >-
      Collection of extension names after which this extension needs to be
      provisioned.
    fullName: provisionAfterExtensions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'provisionAfterExtensions?: string[]'
      return:
        description: ''
        type: string[]
  - name: provisioningState
    uid: '@azure/arm-compute.VirtualMachineScaleSetExtension.provisioningState'
    package: '@azure/arm-compute'
    summary: >-
      The provisioning state, which only appears in the response.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: provisioningState
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'provisioningState?: string'
      return:
        description: ''
        type: string
  - name: publisher
    uid: '@azure/arm-compute.VirtualMachineScaleSetExtension.publisher'
    package: '@azure/arm-compute'
    summary: The name of the extension handler publisher.
    fullName: publisher
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'publisher?: string'
      return:
        description: ''
        type: string
  - name: settings
    uid: '@azure/arm-compute.VirtualMachineScaleSetExtension.settings'
    package: '@azure/arm-compute'
    summary: Json formatted public settings for the extension.
    fullName: settings
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'settings?: any'
      return:
        description: ''
        type: any
  - name: suppressFailures
    uid: '@azure/arm-compute.VirtualMachineScaleSetExtension.suppressFailures'
    package: '@azure/arm-compute'
    summary: >-
      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.
    fullName: suppressFailures
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'suppressFailures?: boolean'
      return:
        description: ''
        type: boolean
  - name: type
    uid: '@azure/arm-compute.VirtualMachineScaleSetExtension.type'
    package: '@azure/arm-compute'
    summary: >-
      Resource type

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: type
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'type?: string'
      return:
        description: ''
        type: string
  - name: typeHandlerVersion
    uid: '@azure/arm-compute.VirtualMachineScaleSetExtension.typeHandlerVersion'
    package: '@azure/arm-compute'
    summary: Specifies the version of the script handler.
    fullName: typeHandlerVersion
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'typeHandlerVersion?: string'
      return:
        description: ''
        type: string
  - name: typePropertiesType
    uid: '@azure/arm-compute.VirtualMachineScaleSetExtension.typePropertiesType'
    package: '@azure/arm-compute'
    summary: >-
      Specifies the type of the extension; an example is
      "CustomScriptExtension".
    fullName: typePropertiesType
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'typePropertiesType?: string'
      return:
        description: ''
        type: string
inheritedProperties:
  - name: id
    uid: '@azure/arm-compute.VirtualMachineScaleSetExtension.id'
    package: '@azure/arm-compute'
    summary: >-
      Resource Id

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: id
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'id?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [SubResourceReadOnly.id](xref:@azure/arm-compute.SubResourceReadOnly.id)
extends: <xref uid="@azure/arm-compute.SubResourceReadOnly" />