Class RedisResourceInner

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.core.management.Resource
com.azure.resourcemanager.redis.fluent.models.RedisResourceInner
All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>

public final class RedisResourceInner extends com.azure.core.management.Resource
A single Redis item in List or Get Operation.
  • Constructor Details

    • RedisResourceInner

      public RedisResourceInner()
      Creates an instance of RedisResourceInner class.
  • Method Details

    • zones

      public List<String> zones()
      Get the zones property: A list of availability zones denoting where the resource needs to come from.
      Returns:
      the zones value.
    • withZones

      public RedisResourceInner withZones(List<String> 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.
    • identity

      public ManagedServiceIdentity identity()
      Get the identity property: The identity of the resource.
      Returns:
      the identity value.
    • 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.
    • type

      public String type()
      Get the type property: The type of the resource.
      Overrides:
      type in class com.azure.core.management.ProxyResource
      Returns:
      the type value.
    • name

      public String name()
      Get the name property: The name of the resource.
      Overrides:
      name in class com.azure.core.management.ProxyResource
      Returns:
      the name value.
    • id

      public String id()
      Get the id property: Fully qualified resource Id for the resource.
      Overrides:
      id in class com.azure.core.management.ProxyResource
      Returns:
      the id value.
    • withLocation

      public RedisResourceInner withLocation(String location)
      Overrides:
      withLocation in class com.azure.core.management.Resource
    • withTags

      public RedisResourceInner withTags(Map<String,String> tags)
      Overrides:
      withTags in class com.azure.core.management.Resource
    • provisioningState

      public ProvisioningState provisioningState()
      Get the provisioningState property: Redis instance provisioning status.
      Returns:
      the provisioningState value.
    • hostname

      public String hostname()
      Get the hostname property: Redis host name.
      Returns:
      the hostname value.
    • port

      public Integer port()
      Get the port property: Redis non-SSL port.
      Returns:
      the port value.
    • sslPort

      public Integer sslPort()
      Get the sslPort property: Redis SSL port.
      Returns:
      the sslPort value.
    • 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.
    • linkedServers

      public List<RedisLinkedServer> linkedServers()
      Get the linkedServers property: List of the linked servers associated with the cache.
      Returns:
      the linkedServers value.
    • instances

      public List<RedisInstanceDetails> instances()
      Get the instances property: List of the Redis instances associated with the cache.
      Returns:
      the instances value.
    • privateEndpointConnections

      public List<PrivateEndpointConnectionInner> privateEndpointConnections()
      Get the privateEndpointConnections property: List of private endpoint connection associated with the specified redis cache.
      Returns:
      the privateEndpointConnections value.
    • sku

      public Sku sku()
      Get the sku property: The SKU of the Redis cache to deploy.
      Returns:
      the sku value.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • enableNonSslPort

      public Boolean enableNonSslPort()
      Get the enableNonSslPort property: Specifies whether the non-ssl Redis server port (6379) is enabled.
      Returns:
      the enableNonSslPort value.
    • 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.
    • replicasPerMaster

      public Integer replicasPerMaster()
      Get the replicasPerMaster property: The number of replicas to be created per primary.
      Returns:
      the replicasPerMaster value.
    • 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.
    • replicasPerPrimary

      public Integer replicasPerPrimary()
      Get the replicasPerPrimary property: The number of replicas to be created per primary.
      Returns:
      the replicasPerPrimary value.
    • 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.
    • tenantSettings

      public Map<String,String> tenantSettings()
      Get the tenantSettings property: A dictionary of tenant settings.
      Returns:
      the tenantSettings value.
    • withTenantSettings

      public RedisResourceInner withTenantSettings(Map<String,String> tenantSettings)
      Set the tenantSettings property: A dictionary of tenant settings.
      Parameters:
      tenantSettings - the tenantSettings value to set.
      Returns:
      the RedisResourceInner object itself.
    • shardCount

      public Integer shardCount()
      Get the shardCount property: The number of shards to be created on a Premium Cluster Cache.
      Returns:
      the shardCount value.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • zonalAllocationPolicy

      public ZonalAllocationPolicy zonalAllocationPolicy()
      Get 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.
      Returns:
      the zonalAllocationPolicy value.
    • withZonalAllocationPolicy

      public RedisResourceInner withZonalAllocationPolicy(ZonalAllocationPolicy zonalAllocationPolicy)
      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.
      Parameters:
      zonalAllocationPolicy - the zonalAllocationPolicy value to set.
      Returns:
      the RedisResourceInner object itself.
    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.
    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
      Overrides:
      toJson in class com.azure.core.management.Resource
      Throws:
      IOException
    • fromJson

      public static RedisResourceInner fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the RedisResourceInner.