Interface RedisCache
- All Superinterfaces:
GroupableResource<RedisManager,,RedisResourceInner> HasId,HasInnerModel<RedisResourceInner>,HasManager<RedisManager>,HasName,HasResourceGroup,Indexable,Refreshable<RedisCache>,Resource,SupportsListingPrivateEndpointConnection,SupportsListingPrivateLinkResource,SupportsUpdatingPrivateEndpointConnection,Updatable<RedisCache.Update>
- All Known Subinterfaces:
RedisCachePremium
public interface RedisCache
extends GroupableResource<RedisManager,RedisResourceInner>, Refreshable<RedisCache>, Updatable<RedisCache.Update>, SupportsListingPrivateLinkResource, SupportsListingPrivateEndpointConnection, SupportsUpdatingPrivateEndpointConnection
An immutable client-side representation of an Azure Redis Cache.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceContainer interface for all the definitions that need to be implemented.static interfaceGrouping of all the Redis Cache definition stages.static enummajor version of redis for version 4.x.x, use V4 for version 6.x.x, use V6static interfaceThe template for a Redis Cache update operation, containing all the settings that can be modified.static interfaceGrouping of all the Redis Cache update stages.Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource
Resource.DefinitionWithRegion<T>, Resource.DefinitionWithTags<T>, Resource.UpdateWithTags<T> -
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets an instance of the Azure Redis cache with Premium SKU.Gets firewall rules in the Redis Cache.voidforceReboot(RebootType rebootType) Reboot specified Redis node(s).hostname()Gets the host name.booleanChecks whether current Redis Cache instance has Premium Sku.keys()Gets a Redis Cache's access keys.Gets the minimum TLS version (or higher) that clients require to use.booleanChecks whether non SSL port is enabled.Gets list of patch schedules for current Redis Cache.intport()Gets the port.Gets the provisioning state.Whether the redis cache can be accessed from public network.Gets the redis configuration.Gets the redis versionFetch the up-to-date access keys from Azure for this Redis Cache.regenerateKey(RedisKeyType keyType) Regenerates the access keys for this Redis Cache.intGets count of the shard.sku()Gets the SKU.intsslPort()Gets SSL port.staticIp()Gets the static IP.subnetId()Gets the resource id of the subnet.Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel
innerModelMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager
managerMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName
nameMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup
resourceGroupNameMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable
refresh, refreshAsyncMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource
region, regionName, tags, typeMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateEndpointConnection
listPrivateEndpointConnections, listPrivateEndpointConnectionsAsyncMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource
listPrivateLinkResources, listPrivateLinkResourcesAsyncMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection
approvePrivateEndpointConnection, approvePrivateEndpointConnectionAsync, rejectPrivateEndpointConnection, rejectPrivateEndpointConnectionAsync
-
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
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
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
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.
-