Package com.azure.resourcemanager.redis.fluent.models

Class RedisCreateProperties

java.lang.Object
com.azure.resourcemanager.redis.models.RedisCommonProperties
com.azure.resourcemanager.redis.fluent.models.RedisCreateProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<RedisCommonProperties>
Direct Known Subclasses:
RedisPropertiesInner
public class RedisCreateProperties extends RedisCommonProperties
Properties supplied to Create Redis operation.

  • Constructor Details

    • RedisCreateProperties

      public RedisCreateProperties()
      Creates an instance of RedisCreateProperties class.

  • Method Details

    • sku

      public Sku sku()
      Get the sku property: The SKU of the Redis cache to deploy.
      Returns:
      the sku value.

    • withSku

      public RedisCreateProperties withSku(Sku sku)
      Set the sku property: The SKU of the Redis cache to deploy.
      Parameters:
      sku - the sku value to set.
      Returns:
      the RedisCreateProperties 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 RedisCreateProperties 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 RedisCreateProperties 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 RedisCreateProperties 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 RedisCreateProperties object itself.

    • withRedisConfiguration

      public RedisCreateProperties 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.
      Overrides:
      withRedisConfiguration in class RedisCommonProperties
      Parameters:
      redisConfiguration - the redisConfiguration value to set.
      Returns:
      the RedisCommonProperties object itself.

    • withRedisVersion

      public RedisCreateProperties 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'.
      Overrides:
      withRedisVersion in class RedisCommonProperties
      Parameters:
      redisVersion - the redisVersion value to set.
      Returns:
      the RedisCommonProperties object itself.

    • withEnableNonSslPort

      public RedisCreateProperties withEnableNonSslPort(Boolean enableNonSslPort)
      Set the enableNonSslPort property: Specifies whether the non-ssl Redis server port (6379) is enabled.
      Overrides:
      withEnableNonSslPort in class RedisCommonProperties
      Parameters:
      enableNonSslPort - the enableNonSslPort value to set.
      Returns:
      the RedisCommonProperties object itself.

    • withReplicasPerMaster

      public RedisCreateProperties withReplicasPerMaster(Integer replicasPerMaster)
      Set the replicasPerMaster property: The number of replicas to be created per primary.
      Overrides:
      withReplicasPerMaster in class RedisCommonProperties
      Parameters:
      replicasPerMaster - the replicasPerMaster value to set.
      Returns:
      the RedisCommonProperties object itself.

    • withReplicasPerPrimary

      public RedisCreateProperties withReplicasPerPrimary(Integer replicasPerPrimary)
      Set the replicasPerPrimary property: The number of replicas to be created per primary.
      Overrides:
      withReplicasPerPrimary in class RedisCommonProperties
      Parameters:
      replicasPerPrimary - the replicasPerPrimary value to set.
      Returns:
      the RedisCommonProperties object itself.

    • withTenantSettings

      public RedisCreateProperties withTenantSettings(Map<String,String> tenantSettings)
      Set the tenantSettings property: A dictionary of tenant settings.
      Overrides:
      withTenantSettings in class RedisCommonProperties
      Parameters:
      tenantSettings - the tenantSettings value to set.
      Returns:
      the RedisCommonProperties object itself.

    • withShardCount

      public RedisCreateProperties withShardCount(Integer shardCount)
      Set the shardCount property: The number of shards to be created on a Premium Cluster Cache.
      Overrides:
      withShardCount in class RedisCommonProperties
      Parameters:
      shardCount - the shardCount value to set.
      Returns:
      the RedisCommonProperties object itself.

    • withMinimumTlsVersion

      public RedisCreateProperties 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').
      Overrides:
      withMinimumTlsVersion in class RedisCommonProperties
      Parameters:
      minimumTlsVersion - the minimumTlsVersion value to set.
      Returns:
      the RedisCommonProperties object itself.

    • withPublicNetworkAccess

      public RedisCreateProperties 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'.
      Overrides:
      withPublicNetworkAccess in class RedisCommonProperties
      Parameters:
      publicNetworkAccess - the publicNetworkAccess value to set.
      Returns:
      the RedisCommonProperties object itself.

    • withUpdateChannel

      public RedisCreateProperties 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'.
      Overrides:
      withUpdateChannel in class RedisCommonProperties
      Parameters:
      updateChannel - the updateChannel value to set.
      Returns:
      the RedisCommonProperties object itself.

    • withDisableAccessKeyAuthentication

      public RedisCreateProperties withDisableAccessKeyAuthentication(Boolean disableAccessKeyAuthentication)
      Set the disableAccessKeyAuthentication property: Authentication to Redis through access keys is disabled when set as true. Default value is false.
      Overrides:
      withDisableAccessKeyAuthentication in class RedisCommonProperties
      Parameters:
      disableAccessKeyAuthentication - the disableAccessKeyAuthentication value to set.
      Returns:
      the RedisCommonProperties object itself.

    • withZonalAllocationPolicy

      public RedisCreateProperties 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.
      Overrides:
      withZonalAllocationPolicy in class RedisCommonProperties
      Parameters:
      zonalAllocationPolicy - the zonalAllocationPolicy value to set.
      Returns:
      the RedisCommonProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class RedisCommonProperties
      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<RedisCommonProperties>
      Overrides:
      toJson in class RedisCommonProperties
      Throws:
      IOException

    • fromJson

      public static RedisCreateProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of RedisCreateProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of RedisCreateProperties 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 RedisCreateProperties.