MachineExtensionProperties Class

  • java.lang.Object
    • com.azure.resourcemanager.hybridcompute.models.MachineExtensionProperties

public final class MachineExtensionProperties

Describes the properties of a Machine Extension.

Constructor Summary

Constructor Description
MachineExtensionProperties()

Creates an instance of MachineExtensionProperties 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 available.

String forceUpdateTag()

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

MachineExtensionInstanceView instanceView()

Get the instanceView property: The machine extension instance view.

Map<String,Object> protectedSettings()

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

String provisioningState()

Get the provisioningState property: The provisioning state, which only appears in the response.

String publisher()

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

Map<String,Object> settings()

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

String type()

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

String typeHandlerVersion()

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

void validate()

Validates the instance.

MachineExtensionProperties withAutoUpgradeMinorVersion(Boolean autoUpgradeMinorVersion)

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

MachineExtensionProperties withEnableAutomaticUpgrade(Boolean enableAutomaticUpgrade)

Set the enableAutomaticUpgrade property: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.

MachineExtensionProperties withForceUpdateTag(String forceUpdateTag)

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

MachineExtensionProperties withInstanceView(MachineExtensionInstanceView instanceView)

Set the instanceView property: The machine extension instance view.

MachineExtensionProperties withProtectedSettings(Map<String,Object> protectedSettings)

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

MachineExtensionProperties withPublisher(String publisher)

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

MachineExtensionProperties withSettings(Map<String,Object> settings)

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

MachineExtensionProperties withType(String type)

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

MachineExtensionProperties withTypeHandlerVersion(String typeHandlerVersion)

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

Methods inherited from java.lang.Object

Constructor Details

MachineExtensionProperties

public MachineExtensionProperties()

Creates an instance of MachineExtensionProperties 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 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.

instanceView

public MachineExtensionInstanceView instanceView()

Get the instanceView property: The machine extension instance view.

Returns:

the instanceView value.

protectedSettings

public Map protectedSettings()

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

Returns:

the protectedSettings value.

provisioningState

public String provisioningState()

Get the provisioningState property: The provisioning state, which only appears in the response.

Returns:

the provisioningState value.

publisher

public String publisher()

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

Returns:

the publisher value.

settings

public Map settings()

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

Returns:

the settings value.

type

public String type()

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

Returns:

the type value.

typeHandlerVersion

public String typeHandlerVersion()

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

Returns:

the typeHandlerVersion value.

validate

public void validate()

Validates the instance.

withAutoUpgradeMinorVersion

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

withEnableAutomaticUpgrade

public MachineExtensionProperties withEnableAutomaticUpgrade(Boolean enableAutomaticUpgrade)

Set the enableAutomaticUpgrade property: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.

Parameters:

enableAutomaticUpgrade - the enableAutomaticUpgrade value to set.

Returns:

the MachineExtensionProperties object itself.

withForceUpdateTag

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

withInstanceView

public MachineExtensionProperties withInstanceView(MachineExtensionInstanceView instanceView)

Set the instanceView property: The machine extension instance view.

Parameters:

instanceView - the instanceView value to set.

Returns:

the MachineExtensionProperties object itself.

withProtectedSettings

public MachineExtensionProperties withProtectedSettings(Map 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 MachineExtensionProperties object itself.

withPublisher

public MachineExtensionProperties withPublisher(String publisher)

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

Parameters:

publisher - the publisher value to set.

Returns:

the MachineExtensionProperties object itself.

withSettings

public MachineExtensionProperties withSettings(Map settings)

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

Parameters:

settings - the settings value to set.

Returns:

the MachineExtensionProperties object itself.

withType

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

withTypeHandlerVersion

public MachineExtensionProperties withTypeHandlerVersion(String typeHandlerVersion)

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

Parameters:

typeHandlerVersion - the typeHandlerVersion value to set.

Returns:

the MachineExtensionProperties object itself.

Applies to