VirtualMachineExtensionInner Class

Package:

com.azure.resourcemanager.compute.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-compute:2.45.0

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.core.management.Resource
    • • com.azure.resourcemanager.compute.models.ResourceWithOptionalLocation
      • • com.azure.resourcemanager.compute.fluent.models.VirtualMachineExtensionInner

public final class VirtualMachineExtensionInner
extends ResourceWithOptionalLocation

Describes a Virtual Machine Extension.

Constructor Summary

Constructor	Description
VirtualMachineExtensionInner()	Creates an instance of VirtualMachineExtensionInner 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 of the extension available.
String	forceUpdateTag() Get the forceUpdateTag property: How the extension handler should be forced to update even if the extension configuration has not changed.
static VirtualMachineExtensionInner	fromJson(JsonReader jsonReader) Reads an instance of VirtualMachineExtensionInner from the JsonReader.
String	id() Get the id property: Fully qualified resource Id for the resource.
VirtualMachineExtensionInstanceView	instanceView() Get the instanceView property: The virtual machine extension instance view.
String	name() Get the name property: The name of the resource.
Object	protectedSettings() Get the protectedSettings property: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
KeyVaultSecretReference	protectedSettingsFromKeyVault() Get the protectedSettingsFromKeyVault property: The extensions protected settings that are passed by reference, and consumed from key vault.
List<String>	provisionAfterExtensions() Get the provisionAfterExtensions property: Collection of extension names after which this extension needs to be provisioned.
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.
Object	settings() Get the settings property: Json formatted public settings for the extension.
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).
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: The type of the resource.
String	typeHandlerVersion() Get the typeHandlerVersion property: Specifies the version of the script handler.
String	typePropertiesType() Get the type property: Specifies the type of the extension; an example is "CustomScriptExtension".
void	validate() Validates the instance.
VirtualMachineExtensionInner	withAutoUpgradeMinorVersion(Boolean autoUpgradeMinorVersion) Set the autoUpgradeMinorVersion property: Indicates whether the extension should use a newer minor version if one is available at deployment time.
VirtualMachineExtensionInner	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.
VirtualMachineExtensionInner	withForceUpdateTag(String forceUpdateTag) Set the forceUpdateTag property: How the extension handler should be forced to update even if the extension configuration has not changed.
VirtualMachineExtensionInner	withInstanceView(VirtualMachineExtensionInstanceView instanceView) Set the instanceView property: The virtual machine extension instance view.
VirtualMachineExtensionInner	withLocation(String location)
VirtualMachineExtensionInner	withProtectedSettings(Object protectedSettings) Set the protectedSettings property: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
VirtualMachineExtensionInner	withProtectedSettingsFromKeyVault(KeyVaultSecretReference protectedSettingsFromKeyVault) Set the protectedSettingsFromKeyVault property: The extensions protected settings that are passed by reference, and consumed from key vault.
VirtualMachineExtensionInner	withProvisionAfterExtensions(List<String> provisionAfterExtensions) Set the provisionAfterExtensions property: Collection of extension names after which this extension needs to be provisioned.
VirtualMachineExtensionInner	withPublisher(String publisher) Set the publisher property: The name of the extension handler publisher.
VirtualMachineExtensionInner	withSettings(Object settings) Set the settings property: Json formatted public settings for the extension.
VirtualMachineExtensionInner	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).
VirtualMachineExtensionInner	withTags(Map<String,String> tags)
VirtualMachineExtensionInner	withTypeHandlerVersion(String typeHandlerVersion) Set the typeHandlerVersion property: Specifies the version of the script handler.
VirtualMachineExtensionInner	withTypePropertiesType(String type) Set the type property: Specifies the type of the extension; an example is "CustomScriptExtension".

Methods inherited from Resource

location tags

Methods inherited from ResourceWithOptionalLocation

fromJson id name toJson type validate withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VirtualMachineExtensionInner

public VirtualMachineExtensionInner()

Creates an instance of VirtualMachineExtensionInner 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 of the extension 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.

fromJson

public static VirtualMachineExtensionInner fromJson(JsonReader jsonReader)

Reads an instance of VirtualMachineExtensionInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of VirtualMachineExtensionInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

VirtualMachineExtensionInner.id()

Returns:

the id value.

instanceView

public VirtualMachineExtensionInstanceView instanceView()

Get the instanceView property: The virtual machine extension instance view.

Returns:

the instanceView value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

VirtualMachineExtensionInner.name()

Returns:

the name value.

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.

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.

provisionAfterExtensions

public List provisionAfterExtensions()

Get the provisionAfterExtensions property: Collection of extension names after which this extension needs to be provisioned.

Returns:

the provisionAfterExtensions 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 Object settings()

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

Returns:

the settings value.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

VirtualMachineExtensionInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

VirtualMachineExtensionInner.type()

Returns:

the type value.

typeHandlerVersion

public String typeHandlerVersion()

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

Returns:

the typeHandlerVersion value.

typePropertiesType

public String typePropertiesType()

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

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

VirtualMachineExtensionInner.validate()

withAutoUpgradeMinorVersion

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

withEnableAutomaticUpgrade

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

withForceUpdateTag

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

withInstanceView

public VirtualMachineExtensionInner withInstanceView(VirtualMachineExtensionInstanceView instanceView)

Set the instanceView property: The virtual machine extension instance view.

Parameters:

instanceView - the instanceView value to set.

Returns:

the VirtualMachineExtensionInner object itself.

withLocation

public VirtualMachineExtensionInner withLocation(String location)

Overrides:

VirtualMachineExtensionInner.withLocation(String location)

Parameters:

location

withProtectedSettings

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

withProtectedSettingsFromKeyVault

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

withProvisionAfterExtensions

public VirtualMachineExtensionInner withProvisionAfterExtensions(List 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 VirtualMachineExtensionInner object itself.

withPublisher

public VirtualMachineExtensionInner withPublisher(String publisher)

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

Parameters:

publisher - the publisher value to set.

Returns:

the VirtualMachineExtensionInner object itself.

withSettings

public VirtualMachineExtensionInner withSettings(Object settings)

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

Parameters:

settings - the settings value to set.

Returns:

the VirtualMachineExtensionInner object itself.

withSuppressFailures

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

withTags

public VirtualMachineExtensionInner withTags(Map tags)

Overrides:

VirtualMachineExtensionInner.withTags(Map<String,String> tags)

Parameters:

tags

withTypeHandlerVersion

public VirtualMachineExtensionInner withTypeHandlerVersion(String typeHandlerVersion)

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

Parameters:

typeHandlerVersion - the typeHandlerVersion value to set.

Returns:

the VirtualMachineExtensionInner object itself.

withTypePropertiesType

public VirtualMachineExtensionInner withTypePropertiesType(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 VirtualMachineExtensionInner object itself.