Redis

Overview

{
	"redis": {
		"name": "redis-instance-{env}",
		"tier": 1,
		"sku": "Premium",

		"@log_analytics_workspace_name": "log-instance-{env}",
		"memory_policy": "VolatileLRU",
		"non_ssl_port": false,
		"public_access": false,
		"tls_version": "1.2",
		"vnet_config": {
			"@vnet_name": "vnet-instance-{env}",
			"@subnet_name": "mysubnetname"
		},
		"location": "centralus",
		"external": false,
		"resource_group_name": "my-rg-name",
		"tags": { "example": "S0" }
	}
}

Reference

KeyTypeDescriptionrequired
namestringThe name of the Redis instance (see how to name)true
tiernumberThe sku tier between 0-9true
skuRedis Sku DefinitionThe SKU name of the Redis instancetrue
@log_analytics_workspace_namestringThe name of the log analytics workspace to bind to (defaults to no log integration)false
memory_policystringThe memory policy to use (defaults to VolatileLRU)false
non_ssl_portboolEnable non-SSL port access (defaults to false)false
public_accessboolEnable public access to the Redis instance (defaults to false)false
tls_VersionTLS versionThe TLS version to use (Defaults to 1.2)false
keyvaultKeyVaultSettingsThe keyvault integration configuration
vnet_configVnet configurationThe configuration of the virtual network (Defaults to no vnet integration)false
locationstringResource Locationfalse
externalboolA reference to an existing Redis instance (defaults to false)false
resource_group_namestringThe name of the resource group where the resource is located, only with external resources (defaults to the resource group of the deployment)
tagsobjectAdditional tags for the resource (defaults to no additional tags)

RedisSku

ValueDescription
BasicBasic Redis instance (does not allow for vnet integration)
StandardStandard Redis instance (does not allow for vnet integration)
PremiumPremium Redis instance (allows vnet integration)

TlsVersion

Value
1.0
1.1
1.2

VnetConfig

KeyTypeDescriptionrequired
@vnet_namestringThe name of the vnet to bind totrue
@subnet_namestringThe name of the subnet inside the vnet to usetrue

KeyVaultSettings

KeyTypeDescription
@key_vault_name (required)stringThe name of the Key Vault to bind to
secretsSecretsThe secret to insert

Secrets

KeyTypeDescription
connection_string (required)stringThe name of the secret holding the Redis connection string
passwordstringThe name of the secret holding the Redis password