RedisProperties Class

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

Inheritance

azure.mgmt.redis.models._models_py3.RedisCreateProperties

RedisProperties

Constructor

RedisProperties(*, sku: azure.mgmt.redis.models._models_py3.Sku, redis_configuration: Optional[azure.mgmt.redis.models._models_py3.RedisCommonPropertiesRedisConfiguration] = None, redis_version: Optional[str] = None, enable_non_ssl_port: Optional[bool] = False, replicas_per_master: Optional[int] = None, replicas_per_primary: Optional[int] = None, tenant_settings: Optional[Dict[str, str]] = None, shard_count: Optional[int] = None, minimum_tls_version: Optional[Union[str, azure.mgmt.redis.models._redis_management_client_enums.TlsVersion]] = None, public_network_access: Optional[Union[str, azure.mgmt.redis.models._redis_management_client_enums.PublicNetworkAccess]] = 'Enabled', subnet_id: Optional[str] = None, static_ip: Optional[str] = None, **kwargs)

Variables

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,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc.

redis_version

str

Redis version. Only major version will be used in PUT/PATCH request with current valid values: (4, 6).

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'). Possible values include: "1.0", "1.1", "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'. Possible values include: "Enabled", "Disabled". Default value: "Enabled".

sku

Sku

Required. The SKU of the Redis cache to deploy.

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.

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. Possible values include: "Creating", "Deleting", "Disabled", "Failed", "Linking", "Provisioning", "RecoveringScaleFailure", "Scaling", "Succeeded", "Unlinking", "Unprovisioning", "Updating".

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.