Class VirtualMachineExtensionProperties
java.lang.Object
com.azure.resourcemanager.compute.fluent.models.VirtualMachineExtensionProperties
Describes the properties of a Virtual Machine Extension.
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an instance of VirtualMachineExtensionProperties 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.Get the instanceView property: The virtual machine extension instance view.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 provisionAfterExtensions property: Collection of extension names after which this extension needs to be provisioned.Get the provisioningState property: The provisioning state, which only appears in the response.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).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.withInstanceView(VirtualMachineExtensionInstanceView instanceView) Set the instanceView property: The virtual machine extension instance view.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.withProvisionAfterExtensions(List<String> provisionAfterExtensions) Set the provisionAfterExtensions property: Collection of extension names after which this extension needs to be provisioned.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.
-
Constructor Details
-
VirtualMachineExtensionProperties
public VirtualMachineExtensionProperties()Creates an instance of VirtualMachineExtensionProperties 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 VirtualMachineExtensionProperties 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 VirtualMachineExtensionProperties 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 VirtualMachineExtensionProperties 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 VirtualMachineExtensionProperties 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 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
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
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
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 VirtualMachineExtensionProperties 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 VirtualMachineExtensionProperties object itself.
-
provisioningState
Get the provisioningState property: The provisioning state, which only appears in the response.- Returns:
- the provisioningState value.
-
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
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 VirtualMachineExtensionProperties 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 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
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.
-