VirtualMachineScaleSetVMExtensionUpdate Class

public final class VirtualMachineScaleSetVMExtensionUpdate
extends SubResourceReadOnly

Describes a VMSS VM Extension.

Constructor Summary

Constructor Description
VirtualMachineScaleSetVMExtensionUpdate()

Creates an instance of VirtualMachineScaleSetVMExtensionUpdate class.

Method Summary

Modifier and Type Method and Description
Boolean autoUpgradeMinorVersion()

Get the autoUpgradeMinorVersion property: Indicates whether the extension should use a newer minor version if one is available at deployment time.

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.

String forceUpdateTag()

Get the forceUpdateTag property: How the extension handler should be forced to update even if the extension configuration has not changed.

String name()

Get the name property: The name of the extension.

Object protectedSettings()

Get the protectedSettings property: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

KeyVaultSecretReference protectedSettingsFromKeyVault()

Get the protectedSettingsFromKeyVault property: The extensions protected settings that are passed by reference, and consumed from key vault.

String publisher()

Get the publisher property: The name of the extension handler publisher.

Object settings()

Get the settings property: Json formatted public settings for the extension.

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).

String type()

Get the type property: Resource type.

String typeHandlerVersion()

Get the typeHandlerVersion property: Specifies the version of the script handler.

String typePropertiesType()

Get the type property: Specifies the type of the extension; an example is "CustomScriptExtension".

void validate()

Validates the instance.

VirtualMachineScaleSetVMExtensionUpdate withAutoUpgradeMinorVersion(Boolean autoUpgradeMinorVersion)

Set the autoUpgradeMinorVersion property: Indicates whether the extension should use a newer minor version if one is available at deployment time.

VirtualMachineScaleSetVMExtensionUpdate 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.

VirtualMachineScaleSetVMExtensionUpdate withForceUpdateTag(String forceUpdateTag)

Set the forceUpdateTag property: How the extension handler should be forced to update even if the extension configuration has not changed.

VirtualMachineScaleSetVMExtensionUpdate withProtectedSettings(Object protectedSettings)

Set the protectedSettings property: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

VirtualMachineScaleSetVMExtensionUpdate withProtectedSettingsFromKeyVault(KeyVaultSecretReference protectedSettingsFromKeyVault)

Set the protectedSettingsFromKeyVault property: The extensions protected settings that are passed by reference, and consumed from key vault.

VirtualMachineScaleSetVMExtensionUpdate withPublisher(String publisher)

Set the publisher property: The name of the extension handler publisher.

VirtualMachineScaleSetVMExtensionUpdate withSettings(Object settings)

Set the settings property: Json formatted public settings for the extension.

VirtualMachineScaleSetVMExtensionUpdate 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).

VirtualMachineScaleSetVMExtensionUpdate withTypeHandlerVersion(String typeHandlerVersion)

Set the typeHandlerVersion property: Specifies the version of the script handler.

VirtualMachineScaleSetVMExtensionUpdate withTypePropertiesType(String type)

Set the type property: Specifies the type of the extension; an example is "CustomScriptExtension".

Methods inherited from SubResourceReadOnly

Methods inherited from java.lang.Object

Constructor Details

VirtualMachineScaleSetVMExtensionUpdate

public VirtualMachineScaleSetVMExtensionUpdate()

Creates an instance of VirtualMachineScaleSetVMExtensionUpdate class.

Method Details

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.

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.

forceUpdateTag

public String forceUpdateTag()

Get the forceUpdateTag property: How the extension handler should be forced to update even if the extension configuration has not changed.

Returns:

the forceUpdateTag value.

name

public String name()

Get the name property: The name of the extension.

Returns:

the name value.

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.

protectedSettingsFromKeyVault

public KeyVaultSecretReference protectedSettingsFromKeyVault()

Get the protectedSettingsFromKeyVault property: The extensions protected settings that are passed by reference, and consumed from key vault.

Returns:

the protectedSettingsFromKeyVault value.

publisher

public String publisher()

Get the publisher property: The name of the extension handler publisher.

Returns:

the publisher value.

settings

public Object settings()

Get the settings property: Json formatted public settings for the extension.

Returns:

the settings value.

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.

type

public String type()

Get the type property: Resource type.

Returns:

the type value.

typeHandlerVersion

public String typeHandlerVersion()

Get the typeHandlerVersion property: Specifies the version of the script handler.

Returns:

the typeHandlerVersion value.

typePropertiesType

public String typePropertiesType()

Get the type property: Specifies the type of the extension; an example is "CustomScriptExtension".

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

VirtualMachineScaleSetVMExtensionUpdate.validate()

withAutoUpgradeMinorVersion

public VirtualMachineScaleSetVMExtensionUpdate 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 VirtualMachineScaleSetVMExtensionUpdate object itself.

withEnableAutomaticUpgrade

public VirtualMachineScaleSetVMExtensionUpdate 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 VirtualMachineScaleSetVMExtensionUpdate object itself.

withForceUpdateTag

public VirtualMachineScaleSetVMExtensionUpdate withForceUpdateTag(String forceUpdateTag)

Set the forceUpdateTag property: How the extension handler should be forced to update even if the extension configuration has not changed.

Parameters:

forceUpdateTag - the forceUpdateTag value to set.

Returns:

the VirtualMachineScaleSetVMExtensionUpdate object itself.

withProtectedSettings

public VirtualMachineScaleSetVMExtensionUpdate 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 VirtualMachineScaleSetVMExtensionUpdate object itself.

withProtectedSettingsFromKeyVault

public VirtualMachineScaleSetVMExtensionUpdate withProtectedSettingsFromKeyVault(KeyVaultSecretReference 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 VirtualMachineScaleSetVMExtensionUpdate object itself.

withPublisher

public VirtualMachineScaleSetVMExtensionUpdate withPublisher(String publisher)

Set the publisher property: The name of the extension handler publisher.

Parameters:

publisher - the publisher value to set.

Returns:

the VirtualMachineScaleSetVMExtensionUpdate object itself.

withSettings

public VirtualMachineScaleSetVMExtensionUpdate withSettings(Object settings)

Set the settings property: Json formatted public settings for the extension.

Parameters:

settings - the settings value to set.

Returns:

the VirtualMachineScaleSetVMExtensionUpdate object itself.

withSuppressFailures

public VirtualMachineScaleSetVMExtensionUpdate 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 VirtualMachineScaleSetVMExtensionUpdate object itself.

withTypeHandlerVersion

public VirtualMachineScaleSetVMExtensionUpdate withTypeHandlerVersion(String typeHandlerVersion)

Set the typeHandlerVersion property: Specifies the version of the script handler.

Parameters:

typeHandlerVersion - the typeHandlerVersion value to set.

Returns:

the VirtualMachineScaleSetVMExtensionUpdate object itself.

withTypePropertiesType

public VirtualMachineScaleSetVMExtensionUpdate withTypePropertiesType(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 VirtualMachineScaleSetVMExtensionUpdate object itself.

Applies to