Class VirtualMachineScaleSetExtensionProperties


  • public final class VirtualMachineScaleSetExtensionProperties
    extends Object
    Describes the properties of a Virtual Machine Scale Set Extension.
    • Constructor Detail

      • VirtualMachineScaleSetExtensionProperties

        public VirtualMachineScaleSetExtensionProperties()
    • Method Detail

      • forceUpdateTag

        public String forceUpdateTag()
        Get the forceUpdateTag property: 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.
        Returns:
        the forceUpdateTag value.
      • withForceUpdateTag

        public VirtualMachineScaleSetExtensionProperties withForceUpdateTag​(String forceUpdateTag)
        Set the forceUpdateTag property: 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.
        Parameters:
        forceUpdateTag - the forceUpdateTag value to set.
        Returns:
        the VirtualMachineScaleSetExtensionProperties object itself.
      • publisher

        public String publisher()
        Get the publisher property: The name of the extension handler publisher.
        Returns:
        the publisher value.
      • withPublisher

        public VirtualMachineScaleSetExtensionProperties withPublisher​(String publisher)
        Set the publisher property: The name of the extension handler publisher.
        Parameters:
        publisher - the publisher value to set.
        Returns:
        the VirtualMachineScaleSetExtensionProperties object itself.
      • type

        public String type()
        Get the type property: Specifies the type of the extension; an example is "CustomScriptExtension".
        Returns:
        the type value.
      • withType

        public VirtualMachineScaleSetExtensionProperties withType​(String type)
        Set the type property: Specifies the type of the extension; an example is "CustomScriptExtension".
        Parameters:
        type - the type value to set.
        Returns:
        the VirtualMachineScaleSetExtensionProperties object itself.
      • typeHandlerVersion

        public String typeHandlerVersion()
        Get the typeHandlerVersion property: Specifies the version of the script handler.
        Returns:
        the typeHandlerVersion value.
      • withTypeHandlerVersion

        public VirtualMachineScaleSetExtensionProperties withTypeHandlerVersion​(String typeHandlerVersion)
        Set the typeHandlerVersion property: Specifies the version of the script handler.
        Parameters:
        typeHandlerVersion - the typeHandlerVersion value to set.
        Returns:
        the VirtualMachineScaleSetExtensionProperties object itself.
      • autoUpgradeMinorVersion

        public Boolean autoUpgradeMinorVersion()
        Get the autoUpgradeMinorVersion property: 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.
        Returns:
        the autoUpgradeMinorVersion value.
      • withAutoUpgradeMinorVersion

        public VirtualMachineScaleSetExtensionProperties withAutoUpgradeMinorVersion​(Boolean autoUpgradeMinorVersion)
        Set the autoUpgradeMinorVersion property: 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.
        Parameters:
        autoUpgradeMinorVersion - the autoUpgradeMinorVersion value to set.
        Returns:
        the VirtualMachineScaleSetExtensionProperties object itself.
      • enableAutomaticUpgrade

        public Boolean enableAutomaticUpgrade()
        Get the enableAutomaticUpgrade property: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
        Returns:
        the enableAutomaticUpgrade value.
      • withEnableAutomaticUpgrade

        public VirtualMachineScaleSetExtensionProperties withEnableAutomaticUpgrade​(Boolean enableAutomaticUpgrade)
        Set the enableAutomaticUpgrade property: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
        Parameters:
        enableAutomaticUpgrade - the enableAutomaticUpgrade value to set.
        Returns:
        the VirtualMachineScaleSetExtensionProperties object itself.
      • settings

        public Object settings()
        Get the settings property: Json formatted public settings for the extension.
        Returns:
        the settings value.
      • withSettings

        public VirtualMachineScaleSetExtensionProperties withSettings​(Object settings)
        Set the settings property: Json formatted public settings for the extension.
        Parameters:
        settings - the settings value to set.
        Returns:
        the VirtualMachineScaleSetExtensionProperties object itself.
      • protectedSettings

        public Object protectedSettings()
        Get the protectedSettings property: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
        Returns:
        the protectedSettings value.
      • withProtectedSettings

        public VirtualMachineScaleSetExtensionProperties withProtectedSettings​(Object protectedSettings)
        Set the protectedSettings property: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
        Parameters:
        protectedSettings - the protectedSettings value to set.
        Returns:
        the VirtualMachineScaleSetExtensionProperties object itself.
      • provisioningState

        public String provisioningState()
        Get the provisioningState property: The provisioning state, which only appears in the response.
        Returns:
        the provisioningState value.
      • provisionAfterExtensions

        public List<String> provisionAfterExtensions()
        Get the provisionAfterExtensions property: Collection of extension names after which this extension needs to be provisioned.
        Returns:
        the provisionAfterExtensions value.
      • withProvisionAfterExtensions

        public VirtualMachineScaleSetExtensionProperties withProvisionAfterExtensions​(List<String> provisionAfterExtensions)
        Set the provisionAfterExtensions property: Collection of extension names after which this extension needs to be provisioned.
        Parameters:
        provisionAfterExtensions - the provisionAfterExtensions value to set.
        Returns:
        the VirtualMachineScaleSetExtensionProperties object itself.
      • suppressFailures

        public Boolean suppressFailures()
        Get the suppressFailures property: 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.
        Returns:
        the suppressFailures value.
      • withSuppressFailures

        public VirtualMachineScaleSetExtensionProperties withSuppressFailures​(Boolean suppressFailures)
        Set the suppressFailures property: 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.
        Parameters:
        suppressFailures - the suppressFailures value to set.
        Returns:
        the VirtualMachineScaleSetExtensionProperties object itself.
      • protectedSettingsFromKeyVault

        public Object protectedSettingsFromKeyVault()
        Get the protectedSettingsFromKeyVault property: The extensions protected settings that are passed by reference, and consumed from key vault.
        Returns:
        the protectedSettingsFromKeyVault value.
      • withProtectedSettingsFromKeyVault

        public VirtualMachineScaleSetExtensionProperties withProtectedSettingsFromKeyVault​(Object protectedSettingsFromKeyVault)
        Set the protectedSettingsFromKeyVault property: The extensions protected settings that are passed by reference, and consumed from key vault.
        Parameters:
        protectedSettingsFromKeyVault - the protectedSettingsFromKeyVault value to set.
        Returns:
        the VirtualMachineScaleSetExtensionProperties object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.