Microsoft.Cache Redis 2015-08-01

아티클
12/09/2024

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@2015-08-01' = {
  location: 'string'
  name: 'string'
  properties: {
    enableNonSslPort: bool
    redisConfiguration: {
      {customized property}: 'string'
    }
    redisVersion: 'string'
    shardCount: int
    sku: {
      capacity: int
      family: 'string'
      name: 'string'
    }
    staticIP: 'string'
    subnet: 'string'
    tenantSettings: {
      {customized property}: 'string'
    }
    virtualNetwork: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

Microsoft.Cache/Redis

Name	Description	Value
location	Resource location.	string (required)
name	The resource name	string (required)
properties	Redis cache properties.	RedisPropertiesOrRedisReadableProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

RedisPropertiesOrRedisReadableProperties

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.	RedisPropertiesRedisConfiguration
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	What SKU of Redis cache to deploy.	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	RedisPropertiesTenantSettings
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

RedisPropertiesRedisConfiguration

Name	Description	Value

RedisPropertiesTenantSettings

Name	Description	Value

ResourceTags

Name	Description	Value

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' (required)
name	What 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": "2015-08-01",
  "name": "string",
  "location": "string",
  "properties": {
    "enableNonSslPort": "bool",
    "redisConfiguration": {
      "{customized property}": "string"
    },
    "redisVersion": "string",
    "shardCount": "int",
    "sku": {
      "capacity": "int",
      "family": "string",
      "name": "string"
    },
    "staticIP": "string",
    "subnet": "string",
    "tenantSettings": {
      "{customized property}": "string"
    },
    "virtualNetwork": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

Microsoft.Cache/Redis

Name	Description	Value
apiVersion	The api version	'2015-08-01'
location	Resource location.	string (required)
name	The resource name	string (required)
properties	Redis cache properties.	RedisPropertiesOrRedisReadableProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Cache/Redis'

RedisPropertiesOrRedisReadableProperties

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.	RedisPropertiesRedisConfiguration
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	What SKU of Redis cache to deploy.	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	RedisPropertiesTenantSettings
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

RedisPropertiesRedisConfiguration

Name	Description	Value

RedisPropertiesTenantSettings

Name	Description	Value

ResourceTags

Name	Description	Value

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' (required)
name	What 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@2015-08-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      enableNonSslPort = bool
      redisConfiguration = {
        {customized property} = "string"
      }
      redisVersion = "string"
      shardCount = int
      sku = {
        capacity = int
        family = "string"
        name = "string"
      }
      staticIP = "string"
      subnet = "string"
      tenantSettings = {
        {customized property} = "string"
      }
      virtualNetwork = "string"
    }
  })
}

Property values

Microsoft.Cache/Redis

Name	Description	Value
location	Resource location.	string (required)
name	The resource name	string (required)
properties	Redis cache properties.	RedisPropertiesOrRedisReadableProperties (required)
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Cache/Redis@2015-08-01"

RedisPropertiesOrRedisReadableProperties

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.	RedisPropertiesRedisConfiguration
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	What SKU of Redis cache to deploy.	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	RedisPropertiesTenantSettings
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

RedisPropertiesRedisConfiguration

Name	Description	Value

RedisPropertiesTenantSettings

Name	Description	Value

ResourceTags

Name	Description	Value

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' (required)
name	What type of Redis cache to deploy. Valid values: (Basic, Standard, Premium).	'Basic' 'Premium' 'Standard' (required)

다음을 통해 공유

Microsoft.Cache Redis 2015-08-01

Bicep resource definition

Resource format

Property values

Microsoft.Cache/Redis

RedisPropertiesOrRedisReadableProperties

RedisPropertiesRedisConfiguration

RedisPropertiesTenantSettings

ResourceTags

Sku

Quickstart samples

ARM template resource definition

Resource format

Property values

Microsoft.Cache/Redis

RedisPropertiesOrRedisReadableProperties

RedisPropertiesRedisConfiguration

RedisPropertiesTenantSettings

ResourceTags

Sku

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

Microsoft.Cache/Redis

RedisPropertiesOrRedisReadableProperties

RedisPropertiesRedisConfiguration

RedisPropertiesTenantSettings

ResourceTags

Sku

피드백

추가 리소스