Microsoft.Cache Redis 2015-08-01

The Redis resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

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

resource symbolicname 'Microsoft.Cache/Redis@2015-08-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    enableNonSslPort: bool
    redisConfiguration: {}
    redisVersion: 'string'
    shardCount: int
    sku: {
      capacity: int
      family: 'string'
      name: 'string'
    }
    staticIP: 'string'
    subnet: 'string'
    tenantSettings: {}
    virtualNetwork: 'string'
  }
}

Property values

Redis

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Cache/Redis'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2015-08-01'
name The resource name string (required)
location Resource location. string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Parameters supplied to CreateOrUpdate Redis operation. RedisProperties (required)

RedisProperties

Name Description Value
enableNonSslPort If the value is true, then the non-SLL Redis server port (6379) will be enabled. bool
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. object
redisVersion RedisVersion parameter has been deprecated. As such, it is no longer necessary to provide this parameter and any value specified is ignored. string
shardCount The number of shards to be created on a Premium Cluster Cache. int
sku SKU parameters supplied to the create Redis operation. Sku (required)
staticIP Required when deploying a Redis cache inside an existing Azure Virtual Network. string
subnet Required when deploying a Redis cache inside an existing Azure Virtual Network. string
tenantSettings tenantSettings object
virtualNetwork The exact ARM resource ID of the virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.ClassicNetwork/VirtualNetworks/vnet1 string

Sku

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Scalable Umbraco CMS Web App

Deploy to Azure
This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.
eShop Website with ILB ASE

Deploy to Azure
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.
Create a Redis Cache using a template

Deploy to Azure
This template creates an Azure Redis Cache with diagnostics data kept in a storage account.
Create a Premium Redis Cache with clustering

Deploy to Azure
This template shows how to configure clustering in a premium Azure Redis Cache instance.
Create Premium Redis Cache with data persistence

Deploy to Azure
This template shows how to configure persistence in a premium Azure Redis Cache instance.
Create Premium Redis Cache deployed into a Virtual Network

Deploy to Azure
This template shows how to deploy a premium Azure Redis Cache instance into a Virtual Network
Create two geo-replicated caches in a Virtual Network

Deploy to Azure
This template shows how to deploy two Premium tier Azure Cache for Redis instances into separate Virtual Networks and link them with geo-replication.
Create a Web App + Redis Cache + SQL DB with a template

Deploy to Azure
This template creates an Azure Web App with Redis cache and a SQL Database.
Create a Web App plus Redis Cache using a template

Deploy to Azure
This template creates an Azure Web App with Redis cache.