RedisCache Interface

Package:

com.azure.resourcemanager.redis.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-redis:2.47.0

Implements

GroupableResource<RedisManager,RedisResourceInner> SupportsListingPrivateEndpointConnection SupportsListingPrivateLinkResource SupportsUpdatingPrivateEndpointConnection Refreshable<RedisCache> Updatable<Update>

public interface RedisCache
extends GroupableResource<RedisManager,RedisResourceInner>, Refreshable<RedisCache>, Updatable<Update>, SupportsListingPrivateLinkResource, SupportsListingPrivateEndpointConnection, SupportsUpdatingPrivateEndpointConnection

An immutable client-side representation of an Azure Redis Cache.

Method Summary

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

Method Details

asPremium

public abstract RedisCachePremium asPremium()

Gets an instance of the Azure Redis cache with Premium SKU.

Returns:

exposes features available only to Premium Sku Redis Cache instances.

firewallRules

public abstract Map firewallRules()

Gets firewall rules in the Redis Cache.

Returns:

Firewall Rules in the Redis Cache, indexed by name

forceReboot

public abstract 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'.

hostname

public abstract String hostname()

Gets the host name.

Returns:

the hostname value

isPremium

public abstract boolean isPremium()

Checks whether current Redis Cache instance has Premium Sku.

Returns:

returns true if current Redis Cache instance has Premium Sku.

keys

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

minimumTlsVersion

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

nonSslPort

public abstract boolean nonSslPort()

Checks whether non SSL port is enabled.

Returns:

true if non SSL port is enabled, false otherwise

patchSchedules

public abstract List patchSchedules()

Gets list of patch schedules for current Redis Cache.

Returns:

List of patch schedules for current Redis Cache.

port

public abstract int port()

Gets the port.

Returns:

the port value

provisioningState

public abstract String provisioningState()

Gets the provisioning state.

Returns:

the provisioningState value

publicNetworkAccess

public abstract PublicNetworkAccess publicNetworkAccess()

Whether the redis cache can be accessed from public network.

Returns:

whether the redis cache can be accessed from public network.

redisConfiguration

public abstract Map redisConfiguration()

Gets the redis configuration.

Returns:

the Redis configuration value

redisVersion

public abstract String redisVersion()

Gets the redis version

Returns:

the Redis version value

refreshKeys

public abstract RedisAccessKeys refreshKeys()

Fetch the up-to-date access keys from Azure for this Redis Cache.

Returns:

the access keys for this Redis Cache

regenerateKey

public abstract 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

shardCount

public abstract int shardCount()

Gets count of the shard.

Returns:

the shardCount value

sku

public abstract Sku sku()

Gets the SKU.

Returns:

the sku value

sslPort

public abstract int sslPort()

Gets SSL port.

Returns:

the sslPort value

staticIp

public abstract String staticIp()

Gets the static IP.

Returns:

the staticIP value

subnetId

public abstract String subnetId()

Gets the resource id of the subnet.

Returns:

the subnetId value