Class VirtualMachineExtensionUpdateProperties
java.lang.Object
com.azure.resourcemanager.compute.fluent.models.VirtualMachineExtensionUpdateProperties
- All Implemented Interfaces:
com.azure.json.JsonSerializable<VirtualMachineExtensionUpdateProperties>
public final class VirtualMachineExtensionUpdateProperties
extends Object
implements com.azure.json.JsonSerializable<VirtualMachineExtensionUpdateProperties>
Describes the properties of a Virtual Machine Extension.
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an instance of VirtualMachineExtensionUpdateProperties class. -
Method Summary
Modifier and TypeMethodDescriptionGet the autoUpgradeMinorVersion property: Indicates whether the extension should use a newer minor version if one is available at deployment time.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.Get the forceUpdateTag property: How the extension handler should be forced to update even if the extension configuration has not changed.fromJson(com.azure.json.JsonReader jsonReader) Reads an instance of VirtualMachineExtensionUpdateProperties from the JsonReader.Get the protectedSettings property: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.Get the protectedSettingsFromKeyVault property: The extensions protected settings that are passed by reference, and consumed from key vault.Get the publisher property: The name of the extension handler publisher.settings()Get the settings property: Json formatted public settings for the extension.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).com.azure.json.JsonWritertoJson(com.azure.json.JsonWriter jsonWriter) type()Get the type property: Specifies the type of the extension; an example is "CustomScriptExtension".Get the typeHandlerVersion property: Specifies the version of the script handler.voidvalidate()Validates the instance.withAutoUpgradeMinorVersion(Boolean autoUpgradeMinorVersion) Set the autoUpgradeMinorVersion property: Indicates whether the extension should use a newer minor version if one is available at deployment time.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.withForceUpdateTag(String forceUpdateTag) Set the forceUpdateTag property: How the extension handler should be forced to update even if the extension configuration has not changed.withProtectedSettings(Object protectedSettings) Set the protectedSettings property: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.withProtectedSettingsFromKeyVault(KeyVaultSecretReference protectedSettingsFromKeyVault) Set the protectedSettingsFromKeyVault property: The extensions protected settings that are passed by reference, and consumed from key vault.withPublisher(String publisher) Set the publisher property: The name of the extension handler publisher.withSettings(Object settings) Set the settings property: Json formatted public settings for the extension.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).Set the type property: Specifies the type of the extension; an example is "CustomScriptExtension".withTypeHandlerVersion(String typeHandlerVersion) Set the typeHandlerVersion property: Specifies the version of the script handler.Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.azure.json.JsonSerializable
toJson, toJson, toJsonBytes, toJsonString
-
Constructor Details
-
VirtualMachineExtensionUpdateProperties
public VirtualMachineExtensionUpdateProperties()Creates an instance of VirtualMachineExtensionUpdateProperties class.
-
-
Method Details
-
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.
-
withForceUpdateTag
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 VirtualMachineExtensionUpdateProperties object itself.
-
publisher
Get the publisher property: The name of the extension handler publisher.- Returns:
- the publisher value.
-
withPublisher
Set the publisher property: The name of the extension handler publisher.- Parameters:
publisher- the publisher value to set.- Returns:
- the VirtualMachineExtensionUpdateProperties object itself.
-
type
Get the type property: Specifies the type of the extension; an example is "CustomScriptExtension".- Returns:
- the type value.
-
withType
Set the type property: Specifies the type of the extension; an example is "CustomScriptExtension".- Parameters:
type- the type value to set.- Returns:
- the VirtualMachineExtensionUpdateProperties object itself.
-
typeHandlerVersion
Get the typeHandlerVersion property: Specifies the version of the script handler.- Returns:
- the typeHandlerVersion value.
-
withTypeHandlerVersion
Set the typeHandlerVersion property: Specifies the version of the script handler.- Parameters:
typeHandlerVersion- the typeHandlerVersion value to set.- Returns:
- the VirtualMachineExtensionUpdateProperties object itself.
-
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 VirtualMachineExtensionUpdateProperties 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 VirtualMachineExtensionUpdateProperties object itself.
-
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 VirtualMachineExtensionUpdateProperties 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 VirtualMachineExtensionUpdateProperties object itself.
-
settings
Get the settings property: Json formatted public settings for the extension.- Returns:
- the settings value.
-
withSettings
Set the settings property: Json formatted public settings for the extension.- Parameters:
settings- the settings value to set.- Returns:
- the VirtualMachineExtensionUpdateProperties object itself.
-
protectedSettings
Get the protectedSettings property: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.- Returns:
- the protectedSettings value.
-
withProtectedSettings
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 VirtualMachineExtensionUpdateProperties object itself.
-
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
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 VirtualMachineExtensionUpdateProperties object itself.
-
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 VirtualMachineExtensionUpdateProperties 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 VirtualMachineExtensionUpdateProperties object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException- thrown if the instance is not valid.
-
toJson
- Specified by:
toJsonin interfacecom.azure.json.JsonSerializable<VirtualMachineExtensionUpdateProperties>- Throws:
IOException
-
fromJson
public static VirtualMachineExtensionUpdateProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException Reads an instance of VirtualMachineExtensionUpdateProperties from the JsonReader.- Parameters:
jsonReader- The JsonReader being read.- Returns:
- An instance of VirtualMachineExtensionUpdateProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
- Throws:
IOException- If an error occurs while reading the VirtualMachineExtensionUpdateProperties.
-