Package com.azure.resourcemanager.compute.fluent.models

Class VirtualMachineExtensionProperties

java.lang.Object
com.azure.resourcemanager.compute.fluent.models.VirtualMachineExtensionProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<VirtualMachineExtensionProperties>
public final class VirtualMachineExtensionProperties extends Object implements com.azure.json.JsonSerializable<VirtualMachineExtensionProperties>
Describes the properties of a Virtual Machine Extension.

  • Constructor Details

    • VirtualMachineExtensionProperties

      public VirtualMachineExtensionProperties()
      Creates an instance of VirtualMachineExtensionProperties class.

  • Method Details

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

    • withForceUpdateTag

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

    • publisher

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

    • withPublisher

      public VirtualMachineExtensionProperties withPublisher(String publisher)
      Set the publisher property: The name of the extension handler publisher.
      Parameters:
      publisher - the publisher value to set.
      Returns:
      the VirtualMachineExtensionProperties 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 VirtualMachineExtensionProperties 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 VirtualMachineExtensionProperties object itself.

    • typeHandlerVersion

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

    • withTypeHandlerVersion

      public VirtualMachineExtensionProperties withTypeHandlerVersion(String typeHandlerVersion)
      Set the typeHandlerVersion property: Specifies the version of the script handler.
      Parameters:
      typeHandlerVersion - the typeHandlerVersion value to set.
      Returns:
      the VirtualMachineExtensionProperties 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 VirtualMachineExtensionProperties 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 VirtualMachineExtensionProperties 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 VirtualMachineExtensionProperties 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 VirtualMachineExtensionProperties object itself.

    • settings

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

    • withSettings

      public VirtualMachineExtensionProperties withSettings(Object settings)
      Set the settings property: Json formatted public settings for the extension.
      Parameters:
      settings - the settings value to set.
      Returns:
      the VirtualMachineExtensionProperties 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 VirtualMachineExtensionProperties 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 VirtualMachineExtensionProperties object itself.

    • provisioningState

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

    • instanceView

      public VirtualMachineExtensionInstanceView instanceView()
      Get the instanceView property: The virtual machine extension instance view.
      Returns:
      the instanceView value.

    • withInstanceView

      public VirtualMachineExtensionProperties withInstanceView(VirtualMachineExtensionInstanceView instanceView)
      Set the instanceView property: The virtual machine extension instance view.
      Parameters:
      instanceView - the instanceView value to set.
      Returns:
      the VirtualMachineExtensionProperties 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 VirtualMachineExtensionProperties 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 VirtualMachineExtensionProperties object itself.

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

    • withProtectedSettingsFromKeyVault

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

    • 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 VirtualMachineExtensionProperties 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 VirtualMachineExtensionProperties object itself.

    • validate

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<VirtualMachineExtensionProperties>
      Throws:
      IOException

    • fromJson

      public static VirtualMachineExtensionProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of VirtualMachineExtensionProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of VirtualMachineExtensionProperties 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 VirtualMachineExtensionProperties.