Class RedisPropertiesInner
java.lang.Object
com.azure.resourcemanager.redis.models.RedisCommonProperties
com.azure.resourcemanager.redis.fluent.models.RedisCreateProperties
com.azure.resourcemanager.redis.fluent.models.RedisPropertiesInner
- All Implemented Interfaces:
com.azure.json.JsonSerializable<RedisCommonProperties>
Properties of the redis cache.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the accessKeys property: The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache.static RedisPropertiesInnerfromJson(com.azure.json.JsonReader jsonReader) Reads an instance of RedisPropertiesInner from the JsonReader.hostname()Get the hostname property: Redis host name.Get the instances property: List of the Redis instances associated with the cache.Get the linkedServers property: List of the linked servers associated with the cache.port()Get the port property: Redis non-SSL port.Get the privateEndpointConnections property: List of private endpoint connection associated with the specified redis cache.Get the provisioningState property: Redis instance provisioning status.sslPort()Get the sslPort property: Redis SSL port.com.azure.json.JsonWritertoJson(com.azure.json.JsonWriter jsonWriter) voidvalidate()Validates the instance.withDisableAccessKeyAuthentication(Boolean disableAccessKeyAuthentication) Set the disableAccessKeyAuthentication property: Authentication to Redis through access keys is disabled when set as true.withEnableNonSslPort(Boolean enableNonSslPort) Set the enableNonSslPort property: Specifies whether the non-ssl Redis server port (6379) is enabled.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').withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: Whether or not public endpoint access is allowed for this cache.withRedisConfiguration(RedisConfiguration redisConfiguration) Set the redisConfiguration property: All Redis Settings.withRedisVersion(String redisVersion) Set the redisVersion property: Redis version.withReplicasPerMaster(Integer replicasPerMaster) Set the replicasPerMaster property: The number of replicas to be created per primary.withReplicasPerPrimary(Integer replicasPerPrimary) Set the replicasPerPrimary property: The number of replicas to be created per primary.withShardCount(Integer shardCount) Set the shardCount property: The number of shards to be created on a Premium Cluster Cache.Set the sku property: The SKU of the Redis cache to deploy.withStaticIp(String staticIp) Set the staticIp property: Static IP address.withSubnetId(String subnetId) Set the subnetId property: The full resource ID of a subnet in a virtual network to deploy the Redis cache in.withTenantSettings(Map<String, String> tenantSettings) Set the tenantSettings property: A dictionary of tenant settings.withUpdateChannel(UpdateChannel updateChannel) Set the updateChannel property: Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive.withZonalAllocationPolicy(ZonalAllocationPolicy zonalAllocationPolicy) Set the zonalAllocationPolicy property: Optional: Specifies how availability zones are allocated to the Redis cache.Methods inherited from class com.azure.resourcemanager.redis.fluent.models.RedisCreateProperties
sku, staticIp, subnetIdMethods inherited from class com.azure.resourcemanager.redis.models.RedisCommonProperties
disableAccessKeyAuthentication, enableNonSslPort, minimumTlsVersion, publicNetworkAccess, redisConfiguration, redisVersion, replicasPerMaster, replicasPerPrimary, shardCount, tenantSettings, updateChannel, zonalAllocationPolicyMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.azure.json.JsonSerializable
toJson, toJson, toJsonBytes, toJsonString
-
Constructor Details
-
RedisPropertiesInner
public RedisPropertiesInner()Creates an instance of RedisPropertiesInner class.
-
-
Method Details
-
provisioningState
Get the provisioningState property: Redis instance provisioning status.- Returns:
- the provisioningState value.
-
hostname
Get the hostname property: Redis host name.- Returns:
- the hostname value.
-
port
Get the port property: Redis non-SSL port.- Returns:
- the port value.
-
sslPort
Get the sslPort property: Redis SSL port.- Returns:
- the sslPort value.
-
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.
-
linkedServers
Get the linkedServers property: List of the linked servers associated with the cache.- Returns:
- the linkedServers value.
-
instances
Get the instances property: List of the Redis instances associated with the cache.- Returns:
- the instances value.
-
privateEndpointConnections
Get the privateEndpointConnections property: List of private endpoint connection associated with the specified redis cache.- Returns:
- the privateEndpointConnections value.
-
withSku
Set the sku property: The SKU of the Redis cache to deploy.- Overrides:
withSkuin classRedisCreateProperties- Parameters:
sku- the sku value to set.- Returns:
- the RedisCreateProperties object itself.
-
withSubnetId
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.- Overrides:
withSubnetIdin classRedisCreateProperties- Parameters:
subnetId- the subnetId value to set.- Returns:
- the RedisCreateProperties object itself.
-
withStaticIp
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.- Overrides:
withStaticIpin classRedisCreateProperties- Parameters:
staticIp- the staticIp value to set.- Returns:
- the RedisCreateProperties object itself.
-
withRedisConfiguration
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.- Overrides:
withRedisConfigurationin classRedisCreateProperties- Parameters:
redisConfiguration- the redisConfiguration value to set.- Returns:
- the RedisCommonProperties object itself.
-
withRedisVersion
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'.- Overrides:
withRedisVersionin classRedisCreateProperties- Parameters:
redisVersion- the redisVersion value to set.- Returns:
- the RedisCommonProperties object itself.
-
withEnableNonSslPort
Set the enableNonSslPort property: Specifies whether the non-ssl Redis server port (6379) is enabled.- Overrides:
withEnableNonSslPortin classRedisCreateProperties- Parameters:
enableNonSslPort- the enableNonSslPort value to set.- Returns:
- the RedisCommonProperties object itself.
-
withReplicasPerMaster
Set the replicasPerMaster property: The number of replicas to be created per primary.- Overrides:
withReplicasPerMasterin classRedisCreateProperties- Parameters:
replicasPerMaster- the replicasPerMaster value to set.- Returns:
- the RedisCommonProperties object itself.
-
withReplicasPerPrimary
Set the replicasPerPrimary property: The number of replicas to be created per primary.- Overrides:
withReplicasPerPrimaryin classRedisCreateProperties- Parameters:
replicasPerPrimary- the replicasPerPrimary value to set.- Returns:
- the RedisCommonProperties object itself.
-
withTenantSettings
Set the tenantSettings property: A dictionary of tenant settings.- Overrides:
withTenantSettingsin classRedisCreateProperties- Parameters:
tenantSettings- the tenantSettings value to set.- Returns:
- the RedisCommonProperties object itself.
-
withShardCount
Set the shardCount property: The number of shards to be created on a Premium Cluster Cache.- Overrides:
withShardCountin classRedisCreateProperties- Parameters:
shardCount- the shardCount value to set.- Returns:
- the RedisCommonProperties object itself.
-
withMinimumTlsVersion
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').- Overrides:
withMinimumTlsVersionin classRedisCreateProperties- Parameters:
minimumTlsVersion- the minimumTlsVersion value to set.- Returns:
- the RedisCommonProperties object itself.
-
withPublicNetworkAccess
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'.- Overrides:
withPublicNetworkAccessin classRedisCreateProperties- Parameters:
publicNetworkAccess- the publicNetworkAccess value to set.- Returns:
- the RedisCommonProperties object itself.
-
withUpdateChannel
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'.- Overrides:
withUpdateChannelin classRedisCreateProperties- Parameters:
updateChannel- the updateChannel value to set.- Returns:
- the RedisCommonProperties object itself.
-
withDisableAccessKeyAuthentication
public RedisPropertiesInner withDisableAccessKeyAuthentication(Boolean disableAccessKeyAuthentication) Set the disableAccessKeyAuthentication property: Authentication to Redis through access keys is disabled when set as true. Default value is false.- Overrides:
withDisableAccessKeyAuthenticationin classRedisCreateProperties- Parameters:
disableAccessKeyAuthentication- the disableAccessKeyAuthentication value to set.- Returns:
- the RedisCommonProperties object itself.
-
withZonalAllocationPolicy
Set the zonalAllocationPolicy property: Optional: Specifies how availability zones are allocated to the Redis cache. 'Automatic' enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. 'UserDefined' will select availability zones passed in by you using the 'zones' parameter. 'NoZones' will produce a non-zonal cache. If 'zonalAllocationPolicy' is not passed, it will be set to 'UserDefined' when zones are passed in, otherwise, it will be set to 'Automatic' in regions where zones are supported and 'NoZones' in regions where zones are not supported.- Overrides:
withZonalAllocationPolicyin classRedisCreateProperties- Parameters:
zonalAllocationPolicy- the zonalAllocationPolicy value to set.- Returns:
- the RedisCommonProperties object itself.
-
validate
public void validate()Validates the instance.- Overrides:
validatein classRedisCreateProperties- Throws:
IllegalArgumentException- thrown if the instance is not valid.
-
toJson
- Specified by:
toJsonin interfacecom.azure.json.JsonSerializable<RedisCommonProperties>- Overrides:
toJsonin classRedisCreateProperties- Throws:
IOException
-
fromJson
public static RedisPropertiesInner fromJson(com.azure.json.JsonReader jsonReader) throws IOException Reads an instance of RedisPropertiesInner from the JsonReader.- Parameters:
jsonReader- The JsonReader being read.- Returns:
- An instance of RedisPropertiesInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
- Throws:
IllegalStateException- If the deserialized JSON object was missing any required properties.IOException- If an error occurs while reading the RedisPropertiesInner.
-