Package com.microsoft.azure.management.redis

Interface RedisCache

  • All Superinterfaces:
    com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource<com.microsoft.azure.management.redis.implementation.RedisManager,​com.microsoft.azure.management.redis.implementation.RedisResourceInner>, com.microsoft.azure.management.resources.fluentcore.arm.models.HasId, com.microsoft.azure.management.resources.fluentcore.model.HasInner<com.microsoft.azure.management.redis.implementation.RedisResourceInner>, com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager<com.microsoft.azure.management.redis.implementation.RedisManager>, com.microsoft.azure.management.resources.fluentcore.arm.models.HasName, com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup, com.microsoft.azure.management.resources.fluentcore.model.Indexable, com.microsoft.azure.management.resources.fluentcore.model.Refreshable<RedisCache>, com.microsoft.azure.management.resources.fluentcore.arm.models.Resource, com.microsoft.azure.management.resources.fluentcore.model.Updatable<RedisCache.Update>
    All Known Subinterfaces:
    RedisCachePremium
    public interface RedisCache
extends com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource<com.microsoft.azure.management.redis.implementation.RedisManager,​com.microsoft.azure.management.redis.implementation.RedisResourceInner>, com.microsoft.azure.management.resources.fluentcore.model.Refreshable<RedisCache>, com.microsoft.azure.management.resources.fluentcore.model.Updatable<RedisCache.Update>
    An immutable client-side representation of an Azure Redis Cache.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static interface  RedisCache.Definition
      Container interface for all the definitions that need to be implemented.
      static interface  RedisCache.DefinitionStages
      Grouping of all the Redis Cache definition stages.
      static interface  RedisCache.Update
      The template for a Redis Cache update operation, containing all the settings that can be modified.
      static interface  RedisCache.UpdateStages
      Grouping of all the Redis Cache update stages.

      • Nested classes/interfaces inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource

        com.microsoft.azure.management.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T extends Object>, com.microsoft.azure.management.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T extends Object>, com.microsoft.azure.management.resources.fluentcore.arm.models.Resource.UpdateWithTags<T extends Object>

    • Method Detail

      • asPremium

        RedisCachePremium asPremium()
        Returns:
        exposes features available only to Premium Sku Redis Cache instances.

      • isPremium

        boolean isPremium()
        Returns:
        returns true if current Redis Cache instance has Premium Sku.

      • provisioningState

        String provisioningState()
        Returns:
        the provisioningState value

      • hostName

        String hostName()
        Returns:
        the hostName value

      • port

        int port()
        Returns:
        the port value

      • sslPort

        int sslPort()
        Returns:
        the sslPort value

      • redisVersion

        String redisVersion()
        Returns:
        the Redis version value

      • sku

        Sku sku()
        Returns:
        the sku value

      • redisConfiguration

        Map<String,​String> redisConfiguration()
        Returns:
        the Redis configuration value

      • nonSslPort

        boolean nonSslPort()
        Returns:
        true if non SSL port is enabled, false otherwise

      • shardCount

        int shardCount()
        Returns:
        the shardCount value

      • subnetId

        String subnetId()
        Returns:
        the subnetId value

      • staticIP

        String staticIP()
        Returns:
        the staticIP value

      • minimumTlsVersion

        @Beta(V1_12_0)
TlsVersion minimumTlsVersion()
        Returns:
        the minimum TLS version (or higher) that clients require to use.

      • firewallRules

        @Beta(V1_12_0)
Map<String,​RedisFirewallRule> firewallRules()
        Returns:
        Firewall Rules in the Redis Cache, indexed by name

      • patchSchedules

        @Beta(V1_12_0)
List<ScheduleEntry> patchSchedules()
        Returns:
        List of patch schedules for current Redis Cache.

      • forceReboot

        void forceReboot​(RebootType rebootType)
        Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.
        Parameters:
        rebootType - specifies which Redis node(s) to reboot. Depending on this value data loss is possible. Possible values include: 'PrimaryNode', 'SecondaryNode', 'AllNodes'.

      • getKeys

        RedisAccessKeys getKeys()
        Returns:
        a Redis Cache's access keys. This operation requires write permission to the Cache resource.

      • keys

        RedisAccessKeys keys()
        Returns:
        a Redis Cache's access keys. This operation requires write permission to the Cache resource.

      • refreshKeys

        RedisAccessKeys refreshKeys()
        Fetch the up-to-date access keys from Azure for this Redis Cache.
        Returns:
        the access keys for this Redis Cache

      • regenerateKey

        RedisAccessKeys regenerateKey​(RedisKeyType keyType)
        Regenerates the access keys for this Redis Cache.
        Parameters:
        keyType - key type to regenerate
        Returns:
        the generated access keys for this Redis Cache