VMExtension Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
Maven Artifact:
com.microsoft.azure:azure-batch:11.2.0
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.VMExtension

public class VMExtension

The configuration for virtual machine extensions.

Constructor Summary

Constructor Description
VMExtension()

Method Summary

Modifier and Type Method and Description
Boolean autoUpgradeMinorVersion()

Get indicates whether the extension should use a newer minor version if one is available at deployment time.
Boolean enableAutomaticUpgrade()

Get indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
String name()

Get the name value.
Object protectedSettings()

Get the extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
List<String> provisionAfterExtensions()

Get collection of extension names after which this extension needs to be provisioned.
String publisher()

Get the publisher value.
Object settings()

Get the settings value.
String type()

Get the type value.
String typeHandlerVersion()

Get the typeHandlerVersion value.
VMExtension withAutoUpgradeMinorVersion(Boolean autoUpgradeMinorVersion)

Set indicates whether the extension should use a newer minor version if one is available at deployment time.
VMExtension withEnableAutomaticUpgrade(Boolean enableAutomaticUpgrade)

Set indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
VMExtension withName(String name)

Set the name value.
VMExtension withProtectedSettings(Object protectedSettings)

Set the extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
VMExtension withProvisionAfterExtensions(List<String> provisionAfterExtensions)

Set collection of extension names after which this extension needs to be provisioned.
VMExtension withPublisher(String publisher)

Set the publisher value.
VMExtension withSettings(Object settings)

Set the settings value.
VMExtension withType(String type)

Set the type value.
VMExtension withTypeHandlerVersion(String typeHandlerVersion)

Set the typeHandlerVersion value.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VMExtension

public VMExtension()

Method Details

autoUpgradeMinorVersion

public Boolean autoUpgradeMinorVersion()

Get 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 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

name

public String name()

Get the name value.

Returns:

the name value

protectedSettings

public Object protectedSettings()

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

Returns:

the protectedSettings value

provisionAfterExtensions

public List provisionAfterExtensions()

Get collection of extension names after which this extension needs to be provisioned.

Returns:

the provisionAfterExtensions value

publisher

public String publisher()

Get the publisher value.

Returns:

the publisher value

settings

public Object settings()

Get the settings value.

Returns:

the settings value

type

public String type()

Get the type value.

Returns:

the type value

typeHandlerVersion

public String typeHandlerVersion()

Get the typeHandlerVersion value.

Returns:

the typeHandlerVersion value

withAutoUpgradeMinorVersion

public VMExtension withAutoUpgradeMinorVersion(Boolean autoUpgradeMinorVersion)

Set 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 VMExtension object itself.

withEnableAutomaticUpgrade

public VMExtension withEnableAutomaticUpgrade(Boolean enableAutomaticUpgrade)

Set 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 VMExtension object itself.

withName

public VMExtension withName(String name)

Set the name value.

Parameters:

name - the name value to set

Returns:

the VMExtension object itself.

withProtectedSettings

public VMExtension withProtectedSettings(Object protectedSettings)

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

Parameters:

protectedSettings - the protectedSettings value to set

Returns:

the VMExtension object itself.

withProvisionAfterExtensions

public VMExtension withProvisionAfterExtensions(List provisionAfterExtensions)

Set collection of extension names after which this extension needs to be provisioned.

Parameters:

provisionAfterExtensions - the provisionAfterExtensions value to set

Returns:

the VMExtension object itself.

withPublisher

public VMExtension withPublisher(String publisher)

Set the publisher value.

Parameters:

publisher - the publisher value to set

Returns:

the VMExtension object itself.

withSettings

public VMExtension withSettings(Object settings)

Set the settings value.

Parameters:

settings - the settings value to set

Returns:

the VMExtension object itself.

withType

public VMExtension withType(String type)

Set the type value.

Parameters:

type - the type value to set

Returns:

the VMExtension object itself.

withTypeHandlerVersion

public VMExtension withTypeHandlerVersion(String typeHandlerVersion)

Set the typeHandlerVersion value.

Parameters:

typeHandlerVersion - the typeHandlerVersion value to set

Returns:

the VMExtension object itself.

Applies to