Microsoft.Cache redis 2020-06-01

• Latest
• 2024-11-01
• 2024-04-01-preview
• 2024-03-01
• 2023-08-01
• 2023-05-01-preview
• 2023-04-01
• 2022-06-01
• 2022-05-01
• 2021-06-01
• 2020-12-01
• 2020-06-01
• 2019-07-01
• 2018-03-01
• 2017-10-01
• 2017-02-01
• 2016-04-01
• 2015-08-01

Bicep resource definition

The redis resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Cache/redis resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Cache/redis@2020-06-01' = {
  location: 'string'
  name: 'string'
  properties: {
    enableNonSslPort: bool
    minimumTlsVersion: 'string'
    publicNetworkAccess: 'string'
    redisConfiguration: {
      aof-storage-connection-string-0: 'string'
      aof-storage-connection-string-1: 'string'
      maxfragmentationmemory-reserved: 'string'
      maxmemory-delta: 'string'
      maxmemory-policy: 'string'
      maxmemory-reserved: 'string'
      rdb-backup-enabled: 'string'
      rdb-backup-frequency: 'string'
      rdb-backup-max-snapshot-count: 'string'
      rdb-storage-connection-string: 'string'
    }
    replicasPerMaster: int
    shardCount: int
    sku: {
      capacity: int
      family: 'string'
      name: 'string'
    }
    staticIP: 'string'
    subnetId: 'string'
    tenantSettings: {
      {customized property}: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

Property values

Microsoft.Cache/redis

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	Redis cache properties.	RedisCreatePropertiesOrRedisProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
zones	A list of availability zones denoting where the resource needs to come from.	string[]

RedisCommonPropertiesRedisConfiguration

Name	Description	Value
aof-storage-connection-string-0	First storage account connection string	string
aof-storage-connection-string-1	Second storage account connection string	string
maxfragmentationmemory-reserved	Value in megabytes reserved for fragmentation per shard	string
maxmemory-delta	Value in megabytes reserved for non-cache usage per shard e.g. failover.	string
maxmemory-policy	The eviction strategy used when your data won't fit within its memory limit.	string
maxmemory-reserved	Value in megabytes reserved for non-cache usage per shard e.g. failover.	string
rdb-backup-enabled	Specifies whether the rdb backup is enabled	string
rdb-backup-frequency	Specifies the frequency for creating rdb backup	string
rdb-backup-max-snapshot-count	Specifies the maximum number of snapshots for rdb backup	string
rdb-storage-connection-string	The storage account connection string for storing rdb file	string

RedisCommonPropertiesTenantSettings

Name	Description	Value

RedisCreateParametersTags

Name	Description	Value

RedisCreatePropertiesOrRedisProperties

Name	Description	Value
enableNonSslPort	Specifies whether the non-ssl Redis server port (6379) is enabled.	bool
minimumTlsVersion	Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')	'1.0' '1.1' '1.2'
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'	'Disabled' 'Enabled'
redisConfiguration	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.	RedisCommonPropertiesRedisConfiguration
replicasPerMaster	The number of replicas to be created per master.	int
shardCount	The number of shards to be created on a Premium Cluster Cache.	int
sku	The SKU of the Redis cache to deploy.	Sku (required)
staticIP	Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.	string Constraints: Pattern = ^\d+\.\d+\.\d+\.\d+$
subnetId	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	string Constraints: Pattern = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$
tenantSettings	A dictionary of tenant settings	RedisCommonPropertiesTenantSettings

Sku

Name	Description	Value
capacity	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).	int (required)
family	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).	'C' 'P' (required)
name	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)	'Basic' 'Premium' 'Standard' (required)

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Create a Premium Redis Cache with clustering	This template shows how to configure clustering in a premium Azure Redis Cache instance.
Create a Redis Cache using a template	This template creates an Azure Redis Cache with diagnostics data kept in a storage account.
Create a Redis Cache with Microsoft Entra Authentication.	This template creates a Redis Cache. Then assigns a built-in access policy to a redis user. Then creates a custom access policy. And then assigns the custom access policy to another Redis user.
Create a Web App plus Redis Cache using a template	This template creates an Azure Web App with Redis cache.
Create Premium Redis Cache deployed into a Virtual Network	This template shows how to deploy a premium Azure Redis Cache instance into an existing Virtual Network
Create Premium Redis Cache with data persistence	This template shows how to configure persistence in a premium Azure Redis Cache instance.
Deploy API Management with an external Azure Cache for Redis	This template demonstrates how to create an instance of Azure API Management in the Consumption tier with an external Azure Cache for Redis instance as the API Management external cache.

ARM template resource definition

The redis resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Cache/redis resource, add the following JSON to your template.

{
  "type": "Microsoft.Cache/redis",
  "apiVersion": "2020-06-01",
  "name": "string",
  "location": "string",
  "properties": {
    "enableNonSslPort": "bool",
    "minimumTlsVersion": "string",
    "publicNetworkAccess": "string",
    "redisConfiguration": {
      "aof-storage-connection-string-0": "string",
      "aof-storage-connection-string-1": "string",
      "maxfragmentationmemory-reserved": "string",
      "maxmemory-delta": "string",
      "maxmemory-policy": "string",
      "maxmemory-reserved": "string",
      "rdb-backup-enabled": "string",
      "rdb-backup-frequency": "string",
      "rdb-backup-max-snapshot-count": "string",
      "rdb-storage-connection-string": "string"
    },
    "replicasPerMaster": "int",
    "shardCount": "int",
    "sku": {
      "capacity": "int",
      "family": "string",
      "name": "string"
    },
    "staticIP": "string",
    "subnetId": "string",
    "tenantSettings": {
      "{customized property}": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

Property values

Microsoft.Cache/redis

Name	Description	Value
apiVersion	The api version	'2020-06-01'
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	Redis cache properties.	RedisCreatePropertiesOrRedisProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Cache/redis'
zones	A list of availability zones denoting where the resource needs to come from.	string[]

RedisCommonPropertiesRedisConfiguration

Name	Description	Value
aof-storage-connection-string-0	First storage account connection string	string
aof-storage-connection-string-1	Second storage account connection string	string
maxfragmentationmemory-reserved	Value in megabytes reserved for fragmentation per shard	string
maxmemory-delta	Value in megabytes reserved for non-cache usage per shard e.g. failover.	string
maxmemory-policy	The eviction strategy used when your data won't fit within its memory limit.	string
maxmemory-reserved	Value in megabytes reserved for non-cache usage per shard e.g. failover.	string
rdb-backup-enabled	Specifies whether the rdb backup is enabled	string
rdb-backup-frequency	Specifies the frequency for creating rdb backup	string
rdb-backup-max-snapshot-count	Specifies the maximum number of snapshots for rdb backup	string
rdb-storage-connection-string	The storage account connection string for storing rdb file	string

RedisCommonPropertiesTenantSettings

Name	Description	Value

RedisCreateParametersTags

Name	Description	Value

RedisCreatePropertiesOrRedisProperties

Name	Description	Value
enableNonSslPort	Specifies whether the non-ssl Redis server port (6379) is enabled.	bool
minimumTlsVersion	Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')	'1.0' '1.1' '1.2'
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'	'Disabled' 'Enabled'
redisConfiguration	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.	RedisCommonPropertiesRedisConfiguration
replicasPerMaster	The number of replicas to be created per master.	int
shardCount	The number of shards to be created on a Premium Cluster Cache.	int
sku	The SKU of the Redis cache to deploy.	Sku (required)
staticIP	Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.	string Constraints: Pattern = ^\d+\.\d+\.\d+\.\d+$
subnetId	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	string Constraints: Pattern = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$
tenantSettings	A dictionary of tenant settings	RedisCommonPropertiesTenantSettings

Sku

Name	Description	Value
capacity	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).	int (required)
family	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).	'C' 'P' (required)
name	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)	'Basic' 'Premium' 'Standard' (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create a Premium Redis Cache with clustering	This template shows how to configure clustering in a premium Azure Redis Cache instance.
Create a Redis Cache using a template	This template creates an Azure Redis Cache with diagnostics data kept in a storage account.
Create a Redis Cache with Microsoft Entra Authentication.	This template creates a Redis Cache. Then assigns a built-in access policy to a redis user. Then creates a custom access policy. And then assigns the custom access policy to another Redis user.
Create a Web App + Redis Cache + SQL DB with a template	This template creates an Azure Web App with Redis cache and a SQL Database.
Create a Web App plus Redis Cache using a template	This template creates an Azure Web App with Redis cache.
Create Premium Redis Cache deployed into a Virtual Network	This template shows how to deploy a premium Azure Redis Cache instance into an existing Virtual Network
Create Premium Redis Cache with data persistence	This template shows how to configure persistence in a premium Azure Redis Cache instance.
Create two geo-replicated caches in a Virtual Network	This template shows how to deploy two Premium tier Azure Cache for Redis instances into separate Virtual Networks and link them with geo-replication.
Deploy API Management with an external Azure Cache for Redis	This template demonstrates how to create an instance of Azure API Management in the Consumption tier with an external Azure Cache for Redis instance as the API Management external cache.
eShop Website with ILB ASE	An App Service Environment is a Premium service plan option of Azure App Service that provides a fully isolated and dedicated environment for securely running Azure App Service apps at high scale, including Web Apps, Mobile Apps, and API Apps.
Scalable Umbraco CMS Web App	This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.

Terraform (AzAPI provider) resource definition

The redis resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Cache/redis resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Cache/redis@2020-06-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  zones = [
    "string"
  ]
  body = jsonencode({
    properties = {
      enableNonSslPort = bool
      minimumTlsVersion = "string"
      publicNetworkAccess = "string"
      redisConfiguration = {
        aof-storage-connection-string-0 = "string"
        aof-storage-connection-string-1 = "string"
        maxfragmentationmemory-reserved = "string"
        maxmemory-delta = "string"
        maxmemory-policy = "string"
        maxmemory-reserved = "string"
        rdb-backup-enabled = "string"
        rdb-backup-frequency = "string"
        rdb-backup-max-snapshot-count = "string"
        rdb-storage-connection-string = "string"
      }
      replicasPerMaster = int
      shardCount = int
      sku = {
        capacity = int
        family = "string"
        name = "string"
      }
      staticIP = "string"
      subnetId = "string"
      tenantSettings = {
        {customized property} = "string"
      }
    }
  })
}

Property values

Microsoft.Cache/redis

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	Redis cache properties.	RedisCreatePropertiesOrRedisProperties (required)
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Cache/redis@2020-06-01"
zones	A list of availability zones denoting where the resource needs to come from.	string[]

RedisCommonPropertiesRedisConfiguration

Name	Description	Value
aof-storage-connection-string-0	First storage account connection string	string
aof-storage-connection-string-1	Second storage account connection string	string
maxfragmentationmemory-reserved	Value in megabytes reserved for fragmentation per shard	string
maxmemory-delta	Value in megabytes reserved for non-cache usage per shard e.g. failover.	string
maxmemory-policy	The eviction strategy used when your data won't fit within its memory limit.	string
maxmemory-reserved	Value in megabytes reserved for non-cache usage per shard e.g. failover.	string
rdb-backup-enabled	Specifies whether the rdb backup is enabled	string
rdb-backup-frequency	Specifies the frequency for creating rdb backup	string
rdb-backup-max-snapshot-count	Specifies the maximum number of snapshots for rdb backup	string
rdb-storage-connection-string	The storage account connection string for storing rdb file	string

RedisCommonPropertiesTenantSettings

Name	Description	Value

RedisCreateParametersTags

Name	Description	Value

RedisCreatePropertiesOrRedisProperties

Name	Description	Value
enableNonSslPort	Specifies whether the non-ssl Redis server port (6379) is enabled.	bool
minimumTlsVersion	Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')	'1.0' '1.1' '1.2'
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'	'Disabled' 'Enabled'
redisConfiguration	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.	RedisCommonPropertiesRedisConfiguration
replicasPerMaster	The number of replicas to be created per master.	int
shardCount	The number of shards to be created on a Premium Cluster Cache.	int
sku	The SKU of the Redis cache to deploy.	Sku (required)
staticIP	Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.	string Constraints: Pattern = ^\d+\.\d+\.\d+\.\d+$
subnetId	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	string Constraints: Pattern = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$
tenantSettings	A dictionary of tenant settings	RedisCommonPropertiesTenantSettings

Sku

Name	Description	Value
capacity	The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).	int (required)
family	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).	'C' 'P' (required)
name	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)	'Basic' 'Premium' 'Standard' (required)