Microsoft.Cache Redis 2016-04-01

Template format

To create a Microsoft.Cache/Redis resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Cache/Redis",
  "apiVersion": "2016-04-01",
  "location": "string",
  "tags": {},
  "properties": {
    "redisConfiguration": {},
    "enableNonSslPort": "boolean",
    "tenantSettings": {},
    "shardCount": "integer",
    "subnetId": "string",
    "staticIP": "string",
    "sku": {
      "name": "string",
      "family": "string",
      "capacity": "integer"
    }
  },
  "resources": []
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Cache/Redis object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes The name of the Redis cache.
type enum Yes For JSON - Microsoft.Cache/Redis
apiVersion enum Yes For JSON - 2016-04-01
location string Yes Resource location.
tags object No Resource tags.
properties object Yes Redis cache properties. - RedisCreateProperties object
resources array No firewallRules

RedisCreateProperties object

Name Type Required Value
redisConfiguration object No 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.
enableNonSslPort boolean No Specifies whether the non-ssl Redis server port (6379) is enabled.
tenantSettings object No tenantSettings
shardCount integer No The number of shards to be created on a Premium Cluster Cache.
subnetId string No 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
staticIP string No Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.
sku object Yes The SKU of the Redis cache to deploy. - Sku object

Sku object

Name Type Required Value
name enum Yes The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium). - Basic, Standard, Premium
family enum Yes The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). - C or P
capacity integer Yes 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).

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.