Documentation menu

resources

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

Key Type Description required
name string The name of the Redis instance (see how to name) true
tier number The sku tier between 0-9 true
sku Redis Sku Definition The SKU name of the Redis instance true
@log_analytics_workspace_name string The name of the log analytics workspace to bind to (defaults to no log integration) false
memory_policy string The memory policy to use (defaults to VolatileLRU) false
non_ssl_port bool Enable non-SSL port access (defaults to false) false
public_access bool Enable public access to the Redis instance (defaults to false) false
tls_Version TLS version The TLS version to use (Defaults to 1.2) false
keyvault KeyVaultSettings The keyvault integration configuration
vnet_config Vnet configuration The configuration of the virtual network (Defaults to no vnet integration) false
location string Resource Location false
external bool A reference to an existing Redis instance (defaults to false) false
resource_group_name string The name of the resource group where the resource is located, only with external resources (defaults to the resource group of the deployment)
tags object Additional tags for the resource (defaults to no additional tags)

RedisSku

Value Description
Basic Basic Redis instance (does not allow for vnet integration)
Standard Standard Redis instance (does not allow for vnet integration)
Premium Premium Redis instance (allows vnet integration)

TlsVersion

Value
1.0
1.1
1.2

VnetConfig

Key Type Description required
@vnet_name string The name of the vnet to bind to true
@subnet_name string The name of the subnet inside the vnet to use true

KeyVaultSettings

Key Type Description
@key_vault_name (required) string The name of the Key Vault to bind to
secrets Secrets The secret to insert

Secrets

Key Type Description
connection_string (required) string The name of the secret holding the Redis connection string
password string The name of the secret holding the Redis password