Azure Redis Reference

This topic provides reference information about the Azure Redis service (csb-azure-redis). It details the plans, configuration parameters, and binding credentials.

Plans

The following table lists the plans available for Azure Redis:

Plan	Description
small	Basic plan with 1 GB cache and no failover. High Availability is not provided, and update results in loss of data.
medium	Basic plan with 6 GB cache and no failover. High Availability is not provided, and update results in loss of data.
large	Basic plan with 26 GB cache and no failover. High Availability is not provided, and update results in loss of data.
ha-small	Standard plan with 1 GB cache with high availability and no failover.
ha-medium	Standard plan with 6 GB cache with high availability and no failover.
ha-large	Standard plan with 26 GB cache with high availability and no failover.
ha-P1	A High Availability plan with 1 GB cache and no failover.

Plan Configuration Parameters

When configuring Cloud Service Broker for Azure you can add additional plans. For how to configure plans, see Configure Services with Cloud Service Broker for Azure.

The following table lists parameters which can only be configured for additional plans:

Parameter Name	Description	Default
`name`*	The plan name	n/a
`id`*	A unique GUID	n/a
`description`*	Description of the new plan	n/a
`display_name`	Name to use when displaying plan in marketplace	n/a
`sku_name`	The Redis SKU to use, for example, `"Basic"`	n/a
`family`	The SKU family/pricing group to use, for example, `C` (Basic/Standard) or `P` (Premium)	n/a
`capacity`	The size of the Redis cache to deploy. Must be between 1 and 6.	`1`
`tls_min_version`	The minimum enforced TLS version. Possible values are `"1.0"`, `"1.1"`, `"1.2"`	`"1.2"`
`firewall_rules`	An array of firewall rule start/end IP pairs. For example, `[["1.2.3.4", "2.3.4.5"], ["5.6.7.8", "6.7.8.9"]]`	`[]`
`private_endpoint_subnet_id`	The ID of the subnet within which Private Endpoint for the Redis cache is created	`""`
`private_dns_zone_ids`	An array of Private DNS Zone IDs to create private DNS zone groups for when using Private Endpoints. For example, `["someID", "anotherID"]`	`[]`

You can also add any of the configuration parameters listed in the parameters section to your plan.

Note: If you set a parameter at plan level, developers cannot change the value when creating or updating service instances.

Configuration Parameters

You can provision a service by running:

cf create-service csb-azure-redis PLAN-NAME SERVICE-INSTANCE-NAME -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'

You can update the configuration parameters for a service instance by running:

cf update-service SERVICE-INSTANCE-NAME -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'

The following table lists the parameters that you can configure, using the -c flag, when provisioning a csb-azure-redis service:

Parameter Name	Type	Description	Default	Operation
`instance_name`	string	The name of your MySQL instance. After being set, this cannot be updated. This parameter has the following constraints: Maximum character length: 98 Minimum character length: 6 Allowed characters: lowercase letters and numbers.	`csb-redis-INSTANCE-ID`	provision
`resource_group`	string	The name of the resource group for the instance. This parameter has the following constraints: Maximum character length: 64 Minimum character length: 0 Allowed characters: lowercase letters and numbers.	`rg-INSTANCE-NAME`	provision
`subnet_id`	string	The ID of the Subnet within which the Redis Cache should be deployed. Valid only for Premium SKU. After being set, this cannot be updated.	`''`	provision
`location`	string	The location of the Redis instance. For available locations, see the Microsoft documentation.	`westus`	provision
`azure_tenant_id`	string	The ID of the Azure tenant for the instance.	The value the operator entered for Tenant ID in Ops Manager	provision and update
`azure_subscription_id`	string	The ID of the Azure subscription for the instance.	The value the operator entered for Subscription ID in Ops Manager	provision and update
`azure_client_id`	string	The ID of the Azure service principal to authenticate for service instance creation.	The value the operator entered for Client ID in Ops Manager	provision and update
`azure_client_secret`	string	The secret (password) for the Azure service principal to authenticate for service instance creation.	The value the operator entered for Client Secret in Ops Manager.	provision and update
`skip_provider_registration`	boolean	Set to `true` to skip automatic Azure provider registration. Set if the service principal being used does not have the rights to register providers.	`false`	provision and update
`maxmemory_policy`	string	Max memory eviction policy. Possible values are `volatile-lru`, `allkeys-lru`, `volatile-random`, `allkeys-random`, `volatile-ttl`, `noeviction`.	`volatile-lru`	provision and update

Binding Credentials

The format for binding credentials for Azure Redis is as follows:

{
    "name" : "REDIS-INSTANCE-NAME",
    "host" : "REDIS-HOSTNAME",
    "tls_port" : "REDIS-TLS-PORT",
    "password" : "AUTHENTICATION-PASSWORD",
    "status" : "STATUS-DESCRIPTION"
}

Where:

REDIS-INSTANCE-NAME is the name of the Redis instance.
REDIS-HOSTNAME is the hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
REDIS-TLS-PORT is the TLS port number of the exposed Redis instance.
AUTHENTICATION-PASSWORD is the password to authenticate to the Redis instance.