Share via

RedisResourceInner Class

  • Reference
Package:
com.azure.resourcemanager.redis.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-redis:2.44.0

public final class RedisResourceInner
extends Resource

A single Redis item in List or Get Operation.

Constructor Summary

Constructor Description
RedisResourceInner()

Creates an instance of RedisResourceInner class.

Method Summary

Modifier and Type Method and Description
RedisAccessKeysInner accessKeys()

Get the accessKeys property: The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache.
Boolean disableAccessKeyAuthentication()

Get the disableAccessKeyAuthentication property: Authentication to Redis through access keys is disabled when set as true.
Boolean enableNonSslPort()

Get the enableNonSslPort property: Specifies whether the non-ssl Redis server port (6379) is enabled.
static RedisResourceInner fromJson(JsonReader jsonReader)

Reads an instance of RedisResourceInner from the JsonReader.
String hostname()

Get the hostname property: Redis host name.
String id()

Get the id property: Fully qualified resource Id for the resource.
ManagedServiceIdentity identity()

Get the identity property: The identity of the resource.
List<RedisInstanceDetails> instances()

Get the instances property: List of the Redis instances associated with the cache.
List<RedisLinkedServer> linkedServers()

Get the linkedServers property: List of the linked servers associated with the cache.
TlsVersion minimumTlsVersion()

Get the minimumTlsVersion property: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2').
String name()

Get the name property: The name of the resource.
Integer port()

Get the port property: Redis non-SSL port.
List<PrivateEndpointConnectionInner> privateEndpointConnections()

Get the privateEndpointConnections property: List of private endpoint connection associated with the specified redis cache.
ProvisioningState provisioningState()

Get the provisioningState property: Redis instance provisioning status.
PublicNetworkAccess publicNetworkAccess()

Get the publicNetworkAccess property: Whether or not public endpoint access is allowed for this cache.
RedisConfiguration redisConfiguration()

Get the redisConfiguration property: All Redis Settings.
String redisVersion()

Get the redisVersion property: Redis version.
Integer replicasPerMaster()

Get the replicasPerMaster property: The number of replicas to be created per primary.
Integer replicasPerPrimary()

Get the replicasPerPrimary property: The number of replicas to be created per primary.
Integer shardCount()

Get the shardCount property: The number of shards to be created on a Premium Cluster Cache.
Sku sku()

Get the sku property: The SKU of the Redis cache to deploy.
Integer sslPort()

Get the sslPort property: Redis SSL port.
String staticIp()

Get the staticIp property: Static IP address.
String subnetId()

Get the subnetId property: The full resource ID of a subnet in a virtual network to deploy the Redis cache in.
Map<String,String> tenantSettings()

Get the tenantSettings property: A dictionary of tenant settings.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.
UpdateChannel updateChannel()

Get the updateChannel property: Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive.
void validate()

Validates the instance.
RedisResourceInner withDisableAccessKeyAuthentication(Boolean disableAccessKeyAuthentication)

Set the disableAccessKeyAuthentication property: Authentication to Redis through access keys is disabled when set as true.
RedisResourceInner withEnableNonSslPort(Boolean enableNonSslPort)

Set the enableNonSslPort property: Specifies whether the non-ssl Redis server port (6379) is enabled.
RedisResourceInner withIdentity(ManagedServiceIdentity identity)

Set the identity property: The identity of the resource.
RedisResourceInner withLocation(String location)
RedisResourceInner withMinimumTlsVersion(TlsVersion minimumTlsVersion)

Set the minimumTlsVersion property: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2').
RedisResourceInner withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)

Set the publicNetworkAccess property: Whether or not public endpoint access is allowed for this cache.
RedisResourceInner withRedisConfiguration(RedisConfiguration redisConfiguration)

Set the redisConfiguration property: All Redis Settings.
RedisResourceInner withRedisVersion(String redisVersion)

Set the redisVersion property: Redis version.
RedisResourceInner withReplicasPerMaster(Integer replicasPerMaster)

Set the replicasPerMaster property: The number of replicas to be created per primary.
RedisResourceInner withReplicasPerPrimary(Integer replicasPerPrimary)

Set the replicasPerPrimary property: The number of replicas to be created per primary.
RedisResourceInner withShardCount(Integer shardCount)

Set the shardCount property: The number of shards to be created on a Premium Cluster Cache.
RedisResourceInner withSku(Sku sku)

Set the sku property: The SKU of the Redis cache to deploy.
RedisResourceInner withStaticIp(String staticIp)

Set the staticIp property: Static IP address.
RedisResourceInner withSubnetId(String subnetId)

Set the subnetId property: The full resource ID of a subnet in a virtual network to deploy the Redis cache in.
RedisResourceInner withTags(Map<String,String> tags)
RedisResourceInner withTenantSettings(Map<String,String> tenantSettings)

Set the tenantSettings property: A dictionary of tenant settings.
RedisResourceInner withUpdateChannel(UpdateChannel updateChannel)

Set the updateChannel property: Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive.
RedisResourceInner withZones(List<String> zones)

Set the zones property: A list of availability zones denoting where the resource needs to come from.
List<String> zones()

Get the zones property: A list of availability zones denoting where the resource needs to come from.

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RedisResourceInner

public RedisResourceInner()

Creates an instance of RedisResourceInner class.

Method Details

accessKeys

public RedisAccessKeysInner accessKeys()

Get the accessKeys property: The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache.

Returns:

the accessKeys value.

disableAccessKeyAuthentication

public Boolean disableAccessKeyAuthentication()

Get the disableAccessKeyAuthentication property: Authentication to Redis through access keys is disabled when set as true. Default value is false.

Returns:

the disableAccessKeyAuthentication value.

enableNonSslPort

public Boolean enableNonSslPort()

Get the enableNonSslPort property: Specifies whether the non-ssl Redis server port (6379) is enabled.

Returns:

the enableNonSslPort value.

fromJson

public static RedisResourceInner fromJson(JsonReader jsonReader)

Reads an instance of RedisResourceInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of RedisResourceInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

hostname

public String hostname()

Get the hostname property: Redis host name.

Returns:

the hostname value.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

RedisResourceInner.id()

Returns:

the id value.

identity

public ManagedServiceIdentity identity()

Get the identity property: The identity of the resource.

Returns:

the identity value.

instances

public List instances()

Get the instances property: List of the Redis instances associated with the cache.

Returns:

the instances value.

linkedServers

public List linkedServers()

Get the linkedServers property: List of the linked servers associated with the cache.

Returns:

the linkedServers value.

minimumTlsVersion

public TlsVersion minimumTlsVersion()

Get the minimumTlsVersion property: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2').

Returns:

the minimumTlsVersion value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

RedisResourceInner.name()

Returns:

the name value.

port

public Integer port()

Get the port property: Redis non-SSL port.

Returns:

the port value.

privateEndpointConnections

public List privateEndpointConnections()

Get the privateEndpointConnections property: List of private endpoint connection associated with the specified redis cache.

Returns:

the privateEndpointConnections value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: Redis instance provisioning status.

Returns:

the provisioningState value.

publicNetworkAccess

public PublicNetworkAccess publicNetworkAccess()

Get the publicNetworkAccess property: Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'.

Returns:

the publicNetworkAccess value.

redisConfiguration

public RedisConfiguration redisConfiguration()

Get the redisConfiguration property: All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc.

Returns:

the redisConfiguration value.

redisVersion

public String redisVersion()

Get the redisVersion property: Redis version. This should be in the form 'major[.minor]' (only 'major' is required) or the value 'latest' which refers to the latest stable Redis version that is available. Supported versions: 4.0, 6.0 (latest). Default value is 'latest'.

Returns:

the redisVersion value.

replicasPerMaster

public Integer replicasPerMaster()

Get the replicasPerMaster property: The number of replicas to be created per primary.

Returns:

the replicasPerMaster value.

replicasPerPrimary

public Integer replicasPerPrimary()

Get the replicasPerPrimary property: The number of replicas to be created per primary.

Returns:

the replicasPerPrimary value.

shardCount

public Integer shardCount()

Get the shardCount property: The number of shards to be created on a Premium Cluster Cache.

Returns:

the shardCount value.

sku

public Sku sku()

Get the sku property: The SKU of the Redis cache to deploy.

Returns:

the sku value.

sslPort

public Integer sslPort()

Get the sslPort property: Redis SSL port.

Returns:

the sslPort value.

staticIp

public String staticIp()

Get the staticIp property: Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.

Returns:

the staticIp value.

subnetId

public String subnetId()

Get the subnetId property: The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1.

Returns:

the subnetId value.

tenantSettings

public Map tenantSettings()

Get the tenantSettings property: A dictionary of tenant settings.

Returns:

the tenantSettings value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

RedisResourceInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

RedisResourceInner.type()

Returns:

the type value.

updateChannel

public UpdateChannel updateChannel()

Get the updateChannel property: Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive. Caches using 'Preview' update channel get latest Redis updates at least 4 weeks ahead of 'Stable' channel caches. Default value is 'Stable'.

Returns:

the updateChannel value.

validate

public void validate()

Validates the instance.

withDisableAccessKeyAuthentication

public RedisResourceInner withDisableAccessKeyAuthentication(Boolean disableAccessKeyAuthentication)

Set the disableAccessKeyAuthentication property: Authentication to Redis through access keys is disabled when set as true. Default value is false.

Parameters:

disableAccessKeyAuthentication - the disableAccessKeyAuthentication value to set.

Returns:

the RedisResourceInner object itself.

withEnableNonSslPort

public RedisResourceInner withEnableNonSslPort(Boolean enableNonSslPort)

Set the enableNonSslPort property: Specifies whether the non-ssl Redis server port (6379) is enabled.

Parameters:

enableNonSslPort - the enableNonSslPort value to set.

Returns:

the RedisResourceInner object itself.

withIdentity

public RedisResourceInner withIdentity(ManagedServiceIdentity identity)

Set the identity property: The identity of the resource.

Parameters:

identity - the identity value to set.

Returns:

the RedisResourceInner object itself.

withLocation

public RedisResourceInner withLocation(String location)

Overrides:

RedisResourceInner.withLocation(String location)

Parameters:

location

withMinimumTlsVersion

public RedisResourceInner withMinimumTlsVersion(TlsVersion minimumTlsVersion)

Set the minimumTlsVersion property: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2').

Parameters:

minimumTlsVersion - the minimumTlsVersion value to set.

Returns:

the RedisResourceInner object itself.

withPublicNetworkAccess

public RedisResourceInner withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)

Set the publicNetworkAccess property: Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'.

Parameters:

publicNetworkAccess - the publicNetworkAccess value to set.

Returns:

the RedisResourceInner object itself.

withRedisConfiguration

public RedisResourceInner withRedisConfiguration(RedisConfiguration redisConfiguration)

Set the redisConfiguration property: All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc.

Parameters:

redisConfiguration - the redisConfiguration value to set.

Returns:

the RedisResourceInner object itself.

withRedisVersion

public RedisResourceInner withRedisVersion(String redisVersion)

Set the redisVersion property: Redis version. This should be in the form 'major[.minor]' (only 'major' is required) or the value 'latest' which refers to the latest stable Redis version that is available. Supported versions: 4.0, 6.0 (latest). Default value is 'latest'.

Parameters:

redisVersion - the redisVersion value to set.

Returns:

the RedisResourceInner object itself.

withReplicasPerMaster

public RedisResourceInner withReplicasPerMaster(Integer replicasPerMaster)

Set the replicasPerMaster property: The number of replicas to be created per primary.

Parameters:

replicasPerMaster - the replicasPerMaster value to set.

Returns:

the RedisResourceInner object itself.

withReplicasPerPrimary

public RedisResourceInner withReplicasPerPrimary(Integer replicasPerPrimary)

Set the replicasPerPrimary property: The number of replicas to be created per primary.

Parameters:

replicasPerPrimary - the replicasPerPrimary value to set.

Returns:

the RedisResourceInner object itself.

withShardCount

public RedisResourceInner withShardCount(Integer shardCount)

Set the shardCount property: The number of shards to be created on a Premium Cluster Cache.

Parameters:

shardCount - the shardCount value to set.

Returns:

the RedisResourceInner object itself.

withSku

public RedisResourceInner withSku(Sku sku)

Set the sku property: The SKU of the Redis cache to deploy.

Parameters:

sku - the sku value to set.

Returns:

the RedisResourceInner object itself.

withStaticIp

public RedisResourceInner withStaticIp(String staticIp)

Set the staticIp property: Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.

Parameters:

staticIp - the staticIp value to set.

Returns:

the RedisResourceInner object itself.

withSubnetId

public RedisResourceInner withSubnetId(String subnetId)

Set the subnetId property: The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1.

Parameters:

subnetId - the subnetId value to set.

Returns:

the RedisResourceInner object itself.

withTags

public RedisResourceInner withTags(Map tags)

Overrides:

RedisResourceInner.withTags(Map<String,String> tags)

Parameters:

tags

withTenantSettings

public RedisResourceInner withTenantSettings(Map tenantSettings)

Set the tenantSettings property: A dictionary of tenant settings.

Parameters:

tenantSettings - the tenantSettings value to set.

Returns:

the RedisResourceInner object itself.

withUpdateChannel

public RedisResourceInner withUpdateChannel(UpdateChannel updateChannel)

Set the updateChannel property: Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive. Caches using 'Preview' update channel get latest Redis updates at least 4 weeks ahead of 'Stable' channel caches. Default value is 'Stable'.

Parameters:

updateChannel - the updateChannel value to set.

Returns:

the RedisResourceInner object itself.

withZones

public RedisResourceInner withZones(List zones)

Set the zones property: A list of availability zones denoting where the resource needs to come from.

Parameters:

zones - the zones value to set.

Returns:

the RedisResourceInner object itself.

zones

public List zones()

Get the zones property: A list of availability zones denoting where the resource needs to come from.

Returns:

the zones value.

Applies to