Package com.azure.resourcemanager.compute.models

Class CloudServiceExtensionProperties

  • public final class CloudServiceExtensionProperties
extends Object
    Extension Properties.

    • Constructor Detail

      • CloudServiceExtensionProperties

        public CloudServiceExtensionProperties()

    • Method Detail

      • publisher

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

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

      • type

        public String type()
        Get the type property: Specifies the type of the extension.
        Returns:
        the type value.

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

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

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

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

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

      • settings

        public String 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.

      • withSettings

        public CloudServiceExtensionProperties withSettings​(String 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.

      • protectedSettings

        public String protectedSettings()
        Get the protectedSettings property: Protected settings for the extension which are encrypted before sent to the role instance.
        Returns:
        the protectedSettings value.

      • withProtectedSettings

        public CloudServiceExtensionProperties withProtectedSettings​(String 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.

      • protectedSettingsFromKeyVault

        public CloudServiceVaultAndSecretReference protectedSettingsFromKeyVault()
        Get the protectedSettingsFromKeyVault property: The protectedSettingsFromKeyVault property.
        Returns:
        the protectedSettingsFromKeyVault value.

      • withProtectedSettingsFromKeyVault

        public CloudServiceExtensionProperties withProtectedSettingsFromKeyVault​(CloudServiceVaultAndSecretReference protectedSettingsFromKeyVault)
        Set the protectedSettingsFromKeyVault property: The protectedSettingsFromKeyVault property.
        Parameters:
        protectedSettingsFromKeyVault - the protectedSettingsFromKeyVault value to set.
        Returns:
        the CloudServiceExtensionProperties object itself.

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

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

      • provisioningState

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

      • rolesAppliedTo

        public List<String> 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.

      • withRolesAppliedTo

        public CloudServiceExtensionProperties withRolesAppliedTo​(List<String> 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.

      • validate

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