CloudServiceExtensionProperties Class

Package:

com.azure.resourcemanager.compute.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-compute:2.47.0

• java.lang.Object
• • com.azure.resourcemanager.compute.models.CloudServiceExtensionProperties

Implements

JsonSerializable<CloudServiceExtensionProperties>

public final class CloudServiceExtensionProperties
implements JsonSerializable<CloudServiceExtensionProperties>

Extension Properties.

Constructor Summary

Constructor	Description
CloudServiceExtensionProperties()	Creates an instance of CloudServiceExtensionProperties class.

Method Summary

Modifier and Type	Method and Description
Boolean	autoUpgradeMinorVersion() Get the autoUpgradeMinorVersion property: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.
String	forceUpdateTag() Get the forceUpdateTag property: Tag to force apply the provided public and protected settings.
static CloudServiceExtensionProperties	fromJson(JsonReader jsonReader) Reads an instance of CloudServiceExtensionProperties from the JsonReader.
Object	protectedSettings() Get the protectedSettings property: Protected settings for the extension which are encrypted before sent to the role instance.
CloudServiceVaultAndSecretReference	protectedSettingsFromKeyVault() Get the protectedSettingsFromKeyVault property: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.
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.
List<String>	rolesAppliedTo() Get the rolesAppliedTo property: Optional list of roles to apply this extension.
Object	settings() Get the settings property: Public settings for the extension.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: Specifies the type of the extension.
String	typeHandlerVersion() Get the typeHandlerVersion property: Specifies the version of the extension.
void	validate() Validates the instance.
CloudServiceExtensionProperties	withAutoUpgradeMinorVersion(Boolean autoUpgradeMinorVersion) Set the autoUpgradeMinorVersion property: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.
CloudServiceExtensionProperties	withForceUpdateTag(String forceUpdateTag) Set the forceUpdateTag property: Tag to force apply the provided public and protected settings.
CloudServiceExtensionProperties	withProtectedSettings(Object protectedSettings) Set the protectedSettings property: Protected settings for the extension which are encrypted before sent to the role instance.
CloudServiceExtensionProperties	withProtectedSettingsFromKeyVault(CloudServiceVaultAndSecretReference protectedSettingsFromKeyVault) Set the protectedSettingsFromKeyVault property: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.
CloudServiceExtensionProperties	withPublisher(String publisher) Set the publisher property: The name of the extension handler publisher.
CloudServiceExtensionProperties	withRolesAppliedTo(List<String> rolesAppliedTo) Set the rolesAppliedTo property: Optional list of roles to apply this extension.
CloudServiceExtensionProperties	withSettings(Object settings) Set the settings property: Public settings for the extension.
CloudServiceExtensionProperties	withType(String type) Set the type property: Specifies the type of the extension.
CloudServiceExtensionProperties	withTypeHandlerVersion(String typeHandlerVersion) Set the typeHandlerVersion property: Specifies the version of the extension.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CloudServiceExtensionProperties

public CloudServiceExtensionProperties()

Creates an instance of CloudServiceExtensionProperties class.

Method Details

autoUpgradeMinorVersion

public Boolean autoUpgradeMinorVersion()

Get the autoUpgradeMinorVersion property: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.

Returns:

the autoUpgradeMinorVersion value.

forceUpdateTag

public String forceUpdateTag()

Get the forceUpdateTag property: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not.

Returns:

the forceUpdateTag value.

fromJson

public static CloudServiceExtensionProperties fromJson(JsonReader jsonReader)

Reads an instance of CloudServiceExtensionProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of CloudServiceExtensionProperties 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 CloudServiceExtensionProperties.

protectedSettings

public Object protectedSettings()

Get the protectedSettings property: Protected settings for the extension which are encrypted before sent to the role instance.

Returns:

the protectedSettings value.

protectedSettingsFromKeyVault

public CloudServiceVaultAndSecretReference protectedSettingsFromKeyVault()

Get the protectedSettingsFromKeyVault property: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.

Returns:

the protectedSettingsFromKeyVault 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.

rolesAppliedTo

public List rolesAppliedTo()

Get the rolesAppliedTo property: Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service.

Returns:

the rolesAppliedTo value.

settings

public Object settings()

Get the settings property: Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension.

Returns:

the settings value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: Specifies the type of the extension.

Returns:

the type value.

typeHandlerVersion

public String typeHandlerVersion()

Get the typeHandlerVersion property: Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance.

Returns:

the typeHandlerVersion value.

validate

public void validate()

Validates the instance.

withAutoUpgradeMinorVersion

public CloudServiceExtensionProperties withAutoUpgradeMinorVersion(Boolean autoUpgradeMinorVersion)

Set the autoUpgradeMinorVersion property: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.

Parameters:

autoUpgradeMinorVersion - the autoUpgradeMinorVersion value to set.

Returns:

the CloudServiceExtensionProperties object itself.

withForceUpdateTag

public CloudServiceExtensionProperties withForceUpdateTag(String forceUpdateTag)

Set the forceUpdateTag property: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not.

Parameters:

forceUpdateTag - the forceUpdateTag value to set.

Returns:

the CloudServiceExtensionProperties object itself.

withProtectedSettings

public CloudServiceExtensionProperties withProtectedSettings(Object protectedSettings)

Set the protectedSettings property: Protected settings for the extension which are encrypted before sent to the role instance.

Parameters:

protectedSettings - the protectedSettings value to set.

Returns:

the CloudServiceExtensionProperties object itself.

withProtectedSettingsFromKeyVault

public CloudServiceExtensionProperties withProtectedSettingsFromKeyVault(CloudServiceVaultAndSecretReference protectedSettingsFromKeyVault)

Set the protectedSettingsFromKeyVault property: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.

Parameters:

protectedSettingsFromKeyVault - the protectedSettingsFromKeyVault value to set.

Returns:

the CloudServiceExtensionProperties object itself.

withPublisher

public CloudServiceExtensionProperties withPublisher(String publisher)

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

Parameters:

publisher - the publisher value to set.

Returns:

the CloudServiceExtensionProperties object itself.

withRolesAppliedTo

public CloudServiceExtensionProperties withRolesAppliedTo(List rolesAppliedTo)

Set the rolesAppliedTo property: Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service.

Parameters:

rolesAppliedTo - the rolesAppliedTo value to set.

Returns:

the CloudServiceExtensionProperties object itself.

withSettings

public CloudServiceExtensionProperties withSettings(Object settings)

Set the settings property: Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension.

Parameters:

settings - the settings value to set.

Returns:

the CloudServiceExtensionProperties object itself.

withType

public CloudServiceExtensionProperties withType(String type)

Set the type property: Specifies the type of the extension.

Parameters:

type - the type value to set.

Returns:

the CloudServiceExtensionProperties object itself.

withTypeHandlerVersion

public CloudServiceExtensionProperties withTypeHandlerVersion(String typeHandlerVersion)

Set the typeHandlerVersion property: Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance.

Parameters:

typeHandlerVersion - the typeHandlerVersion value to set.

Returns:

the CloudServiceExtensionProperties object itself.