Interface RedisCache

All Superinterfaces:
com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource<RedisManager, RedisResourceInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasId, com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel<RedisResourceInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager<RedisManager>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasName, com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup, com.azure.resourcemanager.resources.fluentcore.model.Indexable, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<RedisCache>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateEndpointConnection, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource, com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection, com.azure.resourcemanager.resources.fluentcore.model.Updatable<RedisCache.Update>
All Known Subinterfaces:
RedisCachePremium
public interface RedisCache extends com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource<RedisManager, RedisResourceInner>, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<RedisCache>, com.azure.resourcemanager.resources.fluentcore.model.Updatable<RedisCache.Update>, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateEndpointConnection, com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection
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 enum 
    RedisCache.RedisVersion
    major version of redis for version 4.x.x, use V4 for version 6.x.x, use V6
    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.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.UpdateWithTags<T>

  • Field Summary

    Fields inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    DUMMY

  • Method Summary

    Modifier and Type
    Method
    Description
    RedisCachePremium
    asPremium()
    Gets an instance of the Azure Redis cache with Premium SKU.
    Map<String, RedisFirewallRule>
    firewallRules()
    Gets firewall rules in the Redis Cache.
    void
    forceReboot(RebootType rebootType)
    Reboot specified Redis node(s).
    String
    hostname()
    Gets the host name.
    boolean
    isPremium()
    Checks whether current Redis Cache instance has Premium Sku.
    RedisAccessKeys
    keys()
    Gets a Redis Cache's access keys.
    TlsVersion
    minimumTlsVersion()
    Gets the minimum TLS version (or higher) that clients require to use.
    boolean
    nonSslPort()
    Checks whether non SSL port is enabled.
    List<ScheduleEntry>
    patchSchedules()
    Gets list of patch schedules for current Redis Cache.
    int
    port()
    Gets the port.
    String
    provisioningState()
    Gets the provisioning state.
    PublicNetworkAccess
    publicNetworkAccess()
    Whether the redis cache can be accessed from public network.
    Map<String,String>
    redisConfiguration()
    Gets the redis configuration.
    String
    redisVersion()
    Gets the redis version
    RedisAccessKeys
    refreshKeys()
    Fetch the up-to-date access keys from Azure for this Redis Cache.
    RedisAccessKeys
    regenerateKey(RedisKeyType keyType)
    Regenerates the access keys for this Redis Cache.
    int
    shardCount()
    Gets count of the shard.
    Sku
    sku()
    Gets the SKU.
    int
    sslPort()
    Gets SSL port.
    String
    staticIp()
    Gets the static IP.
    String
    subnetId()
    Gets the resource id of the subnet.

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasId

    id

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel

    innerModel

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager

    manager

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName

    name

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup

    resourceGroupName

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Indexable

    key

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable

    refresh, refreshAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    region, regionName, tags, type

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateEndpointConnection

    listPrivateEndpointConnections, listPrivateEndpointConnectionsAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource

    listPrivateLinkResources, listPrivateLinkResourcesAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection

    approvePrivateEndpointConnection, approvePrivateEndpointConnectionAsync, rejectPrivateEndpointConnection, rejectPrivateEndpointConnectionAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Updatable

    update

  • Method Details

    • asPremium

      RedisCachePremium asPremium()
      Gets an instance of the Azure Redis cache with Premium SKU.
      Returns:
      exposes features available only to Premium Sku Redis Cache instances.

    • isPremium

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

    • provisioningState

      String provisioningState()
      Gets the provisioning state.
      Returns:
      the provisioningState value

    • hostname

      String hostname()
      Gets the host name.
      Returns:
      the hostname value

    • port

      int port()
      Gets the port.
      Returns:
      the port value

    • sslPort

      int sslPort()
      Gets SSL port.
      Returns:
      the sslPort value

    • redisVersion

      String redisVersion()
      Gets the redis version
      Returns:
      the Redis version value

    • sku

      Sku sku()
      Gets the SKU.
      Returns:
      the sku value

    • redisConfiguration

      Map<String,String> redisConfiguration()
      Gets the redis configuration.
      Returns:
      the Redis configuration value

    • nonSslPort

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

    • shardCount

      int shardCount()
      Gets count of the shard.
      Returns:
      the shardCount value

    • subnetId

      String subnetId()
      Gets the resource id of the subnet.
      Returns:
      the subnetId value

    • staticIp

      String staticIp()
      Gets the static IP.
      Returns:
      the staticIP value

    • minimumTlsVersion

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

    • firewallRules

      Map<String, RedisFirewallRule> firewallRules()
      Gets firewall rules in the Redis Cache.
      Returns:
      Firewall Rules in the Redis Cache, indexed by name

    • patchSchedules

      List<ScheduleEntry> patchSchedules()
      Gets list of patch schedules for current Redis Cache.
      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'.

    • keys

      RedisAccessKeys keys()
      Gets a Redis Cache's access 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

    • publicNetworkAccess

      PublicNetworkAccess publicNetworkAccess()
      Whether the redis cache can be accessed from public network.
      Returns:
      whether the redis cache can be accessed from public network.