Share via

RedisProperties Class

  • Reference

Properties of the redis cache.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

RedisProperties(*, sku: _models.Sku, redis_configuration: _models.RedisCommonPropertiesRedisConfiguration | None = None, redis_version: str | None = None, enable_non_ssl_port: bool = False, replicas_per_master: int | None = None, replicas_per_primary: int | None = None, tenant_settings: Dict[str, str] | None = None, shard_count: int | None = None, minimum_tls_version: str | _models.TlsVersion | None = None, public_network_access: str | _models.PublicNetworkAccess = 'Enabled', update_channel: str | _models.UpdateChannel | None = None, disable_access_key_authentication: bool = False, zonal_allocation_policy: str | _models.ZonalAllocationPolicy | None = None, subnet_id: str | None = None, static_ip: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
redis_configuration
RedisCommonPropertiesRedisConfiguration

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.

Default value: None
redis_version
str

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'.

Default value: None
enable_non_ssl_port
bool

Specifies whether the non-ssl Redis server port (6379) is enabled.

Default value: False
replicas_per_master
int

The number of replicas to be created per primary.

Default value: None
replicas_per_primary
int

The number of replicas to be created per primary.

Default value: None
tenant_settings
dict[str, str]

A dictionary of tenant settings.

Default value: None
shard_count
int

The number of shards to be created on a Premium Cluster Cache.

Default value: None
minimum_tls_version
str or TlsVersion

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2'). Known values are: "1.0", "1.1", and "1.2".

Default value: None
public_network_access
str or PublicNetworkAccess

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'. Known values are: "Enabled" and "Disabled".

Default value: Enabled
update_channel
str or UpdateChannel

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'. Known values are: "Stable" and "Preview".

Default value: None
disable_access_key_authentication
bool

Authentication to Redis through access keys is disabled when set as true. Default value is false.

Default value: False
zonal_allocation_policy
str or ZonalAllocationPolicy

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. Known values are: "Automatic", "UserDefined", and "NoZones".

Default value: None
sku
Sku

The SKU of the Redis cache to deploy. Required.
subnet_id
str

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. # pylint: disable=line-too-long

Default value: None
static_ip
str

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

Default value: None

Variables

Name Description
redis_configuration
RedisCommonPropertiesRedisConfiguration

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.
redis_version
str

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'.
enable_non_ssl_port
bool

Specifies whether the non-ssl Redis server port (6379) is enabled.
replicas_per_master
int

The number of replicas to be created per primary.
replicas_per_primary
int

The number of replicas to be created per primary.
tenant_settings
dict[str, str]

A dictionary of tenant settings.
shard_count
int

The number of shards to be created on a Premium Cluster Cache.
minimum_tls_version
str or TlsVersion

Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2'). Known values are: "1.0", "1.1", and "1.2".
public_network_access
str or PublicNetworkAccess

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'. Known values are: "Enabled" and "Disabled".
update_channel
str or UpdateChannel

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'. Known values are: "Stable" and "Preview".
disable_access_key_authentication
bool

Authentication to Redis through access keys is disabled when set as true. Default value is false.
zonal_allocation_policy
str or ZonalAllocationPolicy

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. Known values are: "Automatic", "UserDefined", and "NoZones".
sku
Sku

The SKU of the Redis cache to deploy. Required.
subnet_id
str

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. # pylint: disable=line-too-long
static_ip
str

Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.
provisioning_state
str or ProvisioningState

Redis instance provisioning status. Known values are: "Creating", "Deleting", "Disabled", "Failed", "Linking", "Provisioning", "RecoveringScaleFailure", "Scaling", "Succeeded", "Unlinking", "Unprovisioning", "Updating", and "ConfiguringAAD".
host_name
str

Redis host name.
port
int

Redis non-SSL port.
ssl_port
int

Redis SSL port.
access_keys
RedisAccessKeys

The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache.
linked_servers
list[RedisLinkedServer]

List of the linked servers associated with the cache.
instances
list[RedisInstanceDetails]

List of the Redis instances associated with the cache.
private_endpoint_connections
list[PrivateEndpointConnection]

List of private endpoint connection associated with the specified redis cache.